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

Body

application/json
provider
string
required
Example:

"tripletex"

name
string
required
Required string length: 1 - 120
credentials
object
required

Field values keyed by the provider’s credential field keys.

scope
object

Response

The 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

Automatic invoice import: after capture for SFTP, otherwise nightly and through supported webhooks.

capture
object | null
required
scope
object
required
credentials
object
required

Secret values are never returned.

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