Test integration

Version 4.0.24.20 (latest)

Tests the integration to make sure all the settings are working.

Request

POST /integrations/{integration_id}/test
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
integration_id
string
Id of integration

Response

200: Test Result

Datatype
Description
success
boolean
Whether or not the test was successful
message
string
A message representing the results of the test.
delegate_oauth_result
Expand DelegateOauthTest definition...
name
string
Delegate Oauth Connection Name
installation_target_id
string
The ID of the installation target. For Slack, this would be workspace id.
installation_id
string
Installation ID
success
boolean
Whether or not the test was successful

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples