Webhooks
Webhooks notify your application when events happen in Driftwood — contacts created, companies updated, activities logged, etc. Configure an HTTPS endpoint and select which events to subscribe to.
The Webhook Object
Section titled “The Webhook Object”| Field | Type | Description |
|---|---|---|
id | uuid | |
account_id | uuid | |
created_by | uuid | |
url | string | |
description | string | |
secret_prefix | string | |
events | string[] | |
is_active | bool | |
created_at | datetime | |
updated_at | datetime |
Create a webhook endpoint
Section titled “Create a webhook endpoint”Endpoint: webhooks-create
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | |
description | string | No | |
events | string[] | Yes |
curl -X POST https://api.driftwoodapp.com/api/webhooks-create \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"url": "...", "events": []}'Delete a webhook endpoint
Section titled “Delete a webhook endpoint”Endpoint: webhooks-delete
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/webhooks-delete \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'List deliveries for a webhook endpoint
Section titled “List deliveries for a webhook endpoint”Endpoint: webhooks-deliveries
| Field | Type | Required | Description |
|---|---|---|---|
endpoint_id | string | Yes | |
limit | int | No |
curl -X POST https://api.driftwoodapp.com/api/webhooks-deliveries \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"endpoint_id": "..."}'Get a webhook endpoint by ID
Section titled “Get a webhook endpoint by ID”Endpoint: webhooks-get
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/webhooks-get \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'List webhook endpoints
Section titled “List webhook endpoints”Endpoint: webhooks-list
Update a webhook endpoint
Section titled “Update a webhook endpoint”Endpoint: webhooks-update
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
url | string? | No | |
description | string? | No | |
events | string[] | No | |
is_active | bool? | No |
curl -X POST https://api.driftwoodapp.com/api/webhooks-update \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'