Skip to main content
Test an integration

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
credentials
object

Unsaved merge patch over the saved credentials. Requires Admin.

scope
object

Unsaved scope to test with. Requires Admin.

Response

The test ran. A failed connection is a 200 with result failed; read the steps for why.

result
enum<string>
required
Available options:
ok,
ok_with_warnings,
failed
status
enum<string>
required

Status this result maps to. Saved on the integration only when no draft was sent.

Available options:
connected,
invalid_credentials,
permission_denied,
server_error,
not_tested
steps
object[]
required