Home
Content Management API
Main resources
Upload-related
Site Search
Environments
UI
Workflows
Async jobs
Roles & permissions
Webhooks
Hosting & CI integrations
Subscription
Enterprise
Show examples in:
Webhook

A webhook allows to make requests following certain Dato events. It is linked to a Role, which describes what actions can be performed.

Object payload

id  string
ID of webhook
type  string
Must be exactly "webhook"
name  string  Example: "Item type creation/update"

Unique name for the webhook

url  string  Example: "https://www.example.com/webhook"

The URL to be called

enabled  boolean  Example: true

Whether the webhook is enabled and sending events or not

headers  object  Example: {"X-Foo":"Bar"}

Additional headers that will be sent

events  Array<object>
http_basic_user  string, null  Example: "user"

HTTP Basic Authorization username

http_basic_password  string, null  Example: "password"

HTTP Basic Authorization password

custom_payload  string, null  Example: "{ \"message\": \"{{event_type}} event triggered on {{entity_type}}!\", \"entity_id\": \"{{#entity}}{{id}}{{/entity}}\"] }"

A custom payload

payload_api_version  string  Example: "3"

Specifies which API version to use when serializing entities in the webhook payload

nested_items_in_payload  boolean  Example: true

Whether the you want records present in the payload to show blocks expanded or not

auto_retry  boolean  Example: true

If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.

Available endpoints

Did this doc help you?
Still need help?
Explore our forum, contact support, or connect with our sales team. You can also chat live with other users in our Slack channel.