Outgoing webhooks

Outgoing webhooks send data-change notifications to your receiver. They are different from incoming automation webhook triggers.

Configure a webhook

1. Open project API → Webhooks and create a webhook.
2. Enter a Name, optional Description, and the receiver’s URL.
3. Under Triggers, pick the events (create, update, delete) and the entities each trigger covers. Leave the entities on All entities to cover every entity. Add a trigger for each combination you need, such as created Orders and deleted Customers.
4. Choose the HTTP method and configure any receiver authentication headers.
5. Review Enable webhook, save, and test with a disposable record change.
6. Inspect Logs → Webhook executions and the receiver’s result.

Use POST for a receiver expecting the JSON payload. GET deliveries do not carry that JSON body.

A change sends the webhook once, however many of its triggers match it.

Payload and receiver

The envelope contains projectId, type, and data. The data-change event is included under data; inspect a controlled event before depending on operation-specific fields. Create, update, and delete events need not have identical data.

Validate the project and event your receiver expects. Keep processing bounded and design duplicate handling; do not assume exactly-once delivery. Check delivery logs before manually repeating downstream work.

Receiver authentication

The form includes a Secret field, but outgoing delivery does not currently use that field to sign requests. Do not implement signature verification based on an assumed Flexkit signature header. Configure a receiver-specific authentication header over HTTPS and keep its value secret.

The signing mechanism for custom tools is a separate protocol and does not describe outgoing webhook authentication.