Skip to main content
Test an integration

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

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