Outgoing webhooks
Signed notifications of what happens in a workspace.
GET/webhooks
List outgoing webhooks
Needs the permission integrations:read.
curl -X GET https://crm.anibrosdesign.com/api/v1/webhooks \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 401 403 429
POST/webhooks
Create an outgoing webhook
The signing secret is shown once.
Needs the permission integrations:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
Idempotency-Key | header | string | Any unique string up to 128 characters. Repeating the request with the same key returns the first response. up to 128 characters |
| Body field | Type | Notes |
|---|---|---|
name required | string | at least 1 characters. up to 100 characters |
url required | string | at least 8 characters. up to 2000 characters |
events required | list of one of lead.created, lead.assigned, lead.stage_changed, lead.updated, lead.deleted, activity.created, task.created, task.completed, contact.created | at least 1 items. up to 20 items |
curl -X POST https://crm.anibrosdesign.com/api/v1/webhooks \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text","url":"text","events":["lead.created"]}'Responses:
201 400 401 402 403 429
GET/webhooks/deliveries
Get deliveries (webhooks)
Needs the permission integrations:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
limit | query | integer | at least 1. up to 100. default 25 |
cursor | query | string | up to 512 characters |
endpointId | query | string (uuid) | |
status | query | one of pending, delivered, failed, dead, skipped |
curl -X GET https://crm.anibrosdesign.com/api/v1/webhooks/deliveries \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
POST/webhooks/deliveries/{id}/retry
Retry (webhooks)
Needs the permission integrations:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/webhooks/deliveries/{id}/retry \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
204 400 401 402 403 404 429
GET/webhooks/events
Get events (webhooks)
Needs the permission integrations:read.
curl -X GET https://crm.anibrosdesign.com/api/v1/webhooks/events \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 401 403 429
GET/webhooks/{id}
Get a webhook
Needs the permission integrations:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/webhooks/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
PATCH/webhooks/{id}
Change a webhook
Needs the permission integrations:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
name | string | at least 1 characters. up to 100 characters |
url | string | at least 8 characters. up to 2000 characters |
events | list of one of lead.created, lead.assigned, lead.stage_changed, lead.updated, lead.deleted, activity.created, task.created, task.completed, contact.created | at least 1 items. up to 20 items |
status | one of active, paused |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/webhooks/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text","url":"text","events":["lead.created"]}'Responses:
200 400 401 402 403 404 412 429
DELETE/webhooks/{id}
Delete a webhook
Needs the permission integrations:delete.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X DELETE https://crm.anibrosdesign.com/api/v1/webhooks/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
204 400 401 402 403 404 429
POST/webhooks/{id}/rotate-secret
Rotate secret (webhooks)
Needs the permission integrations:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/webhooks/{id}/rotate-secret \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
201 400 401 402 403 404 429
POST/webhooks/{id}/test
Test (webhooks)
Needs the permission integrations:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/webhooks/{id}/test \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
Something missing or unclear? Tell us.