Skip to main content
Update 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.

if-match
string

Optional strong ETag from the individual resource GET. A stale validator returns 412.

Required string length: 1 - 4096

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Required string length: 1 - 120
enabled
boolean
auto_sync
boolean
scope
object
credentials
object

Merge patch: omitted fields keep their saved value and null clears an optional field. Changing credentials resets status to not_tested.

Response

Current resource.

id
string<uuid>
required
provider
string
required
name
string
required
status
enum<string>
required

Result of the latest test or sync. not_tested until the first test.

Available options:
connected,
invalid_credentials,
permission_denied,
server_error,
not_tested
syncable
boolean
required

Enabled and in a status that allows a sync to start.

enabled
boolean
required
auto_sync
boolean
required

Nightly incremental sync, plus webhooks where supported.

scope
object
required
credentials
object
required

Secrets are write-only and never returned to any role.

realtime
object
required
rate_limited_until
string<date-time> | null
required

The provider asked Watchdog to pause requests until this time.

last_successful_sync
object | null
required

Latest sync that completed with full coverage.

active_sync_id
string<uuid> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required