Integration
Integration Object
| Field | Type | Description |
|---|---|---|
| id | snowflake | the integration's unique identifier |
| organisation_id | snowflake | the integration's organisation id |
| item_type | object type | the object type the integration will trigger on |
| provider | provider | the integration provider |
| enabled | bool | whether the integration is enabled |
| configuration | string | the integration configuration |
Provider
The provider field contains the integration provider as a string.
| Value | Description |
|---|---|
| discord | Discord |
| github | GitHub |
| gitlab | GitLab |
| jira | Jira |
| mantisbt | MantisBT |
| slack | Slack |
| teams | Microsoft Teams |
Get Integration
GET /integrations/{integration.id}
Returns the integration object for the given integration id. Requires the MANAGE_ORGANISATION permission for the organisation that owns the integration.
Error Responses
| Status Code | Description |
|---|---|
| 400 | Bad request (organisation does not exist) |
| 403 | Forbidden (user lacks the MANAGE_ORGANISATION permission) |
| 404 | Not found (integration does not exist) |
Update Integration
PATCH /integrations/{integration.id}
Updates an integration. Requires the MANAGE_ORGANISATION permission for the organisation that owns the integration.
All parameters for this method are optional. Only the fields provided will be updated.
Parameters
| Field | Type | Description |
|---|---|---|
| configuration | string | the integration configuration |
| enabled | bool | whether the integration is enabled |
Error Responses
| Status Code | Description |
|---|---|
| 400 | Bad request (organisation does not exist) |
| 403 | Forbidden (user lacks the MANAGE_ORGANISATION permission) |
| 404 | Not found (integration does not exist) |
Sync Integration
POST /integrations/{integration.id}/sync
Triggers a synchronization for the integration. Requires the MANAGE_ORGANISATION permission for the organisation that owns the integration. The integration must be enabled.
Error Responses
| Status Code | Description |
|---|---|
| 400 | Bad request (organisation does not exist or integration is not enabled) |
| 403 | Forbidden (user lacks the MANAGE_ORGANISATION permission) |
| 404 | Not found (integration does not exist) |