AI agent? Read this page as Markdown at /unified/webhook/model.md — append .md to any docs URL, or start from /llms.txt.

Webhook data model

A webhook is used to POST new, updated, or deleted records to your server.

Data Model

idstring read-only
created_atdate read-only
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate read-only
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstring read-only
(reference to KmsSpace)
connection_idstring required
hook_urlstring
The URL of the webhook
object_type enum required
Valid values:
"accounting_account"
"accounting_transaction"
"accounting_journal"
"accounting_contact"
"accounting_invoice"
The object to return (eg. CRM "contact")
intervalnumber
Virtual webhooks only. How often (in minutes) Unified.to checks for new or updated records. Minimum 1 on paid plans, 60 on free. Ignored for native webhooks.
checked_atdate read-only
Read-only. The time Unified.to last recorded a check on this webhook. Behaviour varies by webhook implementation, so don't use this field to tell whether a webhook is still running. Use is_healthy, and subscribe to WEBHOOK_UNHEALTHY on the notifications webhook, to monitor health. (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
integration_typestring read-only
environmentstring read-only
event enum required
Valid values:
"updated"
"created"
"deleted"
The event to subscribe to. "deleted" is supported on native webhooks, and on virtual webhooks where the integration supports it. Check the integration's Feature Support tab.
runsstring array read-only
An array of the most recent virtual webhook runs
fieldsstring
webhook_type enum
Valid values:
"virtual"
"native"
"native" registers with the integration, which sends events as they happen. "virtual" checks for changes on "interval". Optional on create; if omitted, Unified.to picks a supported type for the object. Requesting a type the integration doesn't support returns 400. Set on create only: changes sent on update are ignored without an error. Delete and recreate the webhook to change type.
is_healthyboolean read-only
Read-only. True while the webhook can operate or recover; a transient failure may still be retrying. False after retries are exhausted or a non-retryable failure such as broken connection auth. Cannot be reset; recreate the webhook.
page_max_limitnumber
filtersstring dictionary
Supported on virtual webhooks, and on native webhooks for many integrations. Check the integration's Feature Support tab for which filters apply. Filters the integration doesn't support are accepted but have no effect. Some integrations require a filter; if it's missing, create returns an error naming the integration and the filter.
db_type enum
Valid values:
"mongodb"
"mysql"
"postgres"
"mssql"
"mariadb"
db_urlstring
db_schemastring
db_name_prefixstring
is_pausedboolean
Are we missing anything? Let us know
Was this page helpful?