API Reference
REST Hooks
Programmatic event subscription and unsubscription for integration platforms.
Programmatic event subscription endpoints following the REST Hooks pattern, compatible with Zapier, Make, and similar integration platforms.
Requires hooks:manage scope.
Subscribe
POST /v1/ext/webhooks
Fields
{
"target_url": "string, required",
"event": "string, required"
}
Example
{
"target_url": "https://your-app.com/webhook",
"event": "item.created"
}
Response
{
"id": "01926a3b-...",
"target_url": "https://your-app.com/webhook",
"event": "item.created",
"created_at": "2026-04-01T10:30:00Z"
}
Unsubscribe
DELETE /v1/ext/webhooks/{webhook_id}
Removes the subscription. No further events are sent to the target URL.
Sample data
GET /v1/ext/webhooks/sample/items
Returns a sample item payload with realistic field values. Integration platforms such as Zapier and Make use this to display the data structure to users during setup. The sample uses your actual pipeline blueprint, so field names and types match real payloads.
Difference from outbound webhooks
| Setup | You configure outbound webhooks in the UI via Settings. REST hooks are managed via the API (/v1/ext/webhooks). |
| Auth | Outbound webhooks use your login session. REST hooks use an API key. |
| Use case | Outbound webhooks are for manual configuration. REST hooks are for programmatic integrations (Zapier, Make). |
| Payload | Both send the same item format |
Both deliver the same item data. The difference is how the subscription is managed.