API referenceEndpoints
Webhooks
Signed events POSTed to your URLs.
On this page
List webhook event types
/v1/events/typesResponses
200Every event a webhook endpoint can subscribe to.
dataarray of EventTypeRequiredThis page of results.
EventType fields
typestringRequiredThe event type.
One of:
call.completed,message.taken,appointment.booked,appointment.rescheduled,appointment.canceled,lead.captureddescriptionstringRequiredWhat it means.
has_morebooleanRequiredWhether there are more results after this page.
next_cursorstring or nullRequiredPass as
cursorto get the next page; null on the last page.
- 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 401
Example request
curl https://api.assistcall.ai/v1/events/types \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"data": [
{
"type": "call.completed",
"description": "A call ended. Includes the summary, transcript, caller and receptionist."
}
],
"has_more": false,
"next_cursor": null
}List webhook endpoints
/v1/webhooksScopewebhooks:read
The same endpoints as Integrations → Webhooks in the portal. The signing secret is never listed.
Partner keys send the client's account id in AssistCall-Account.
Query parameters
limitintegerHow many items to return, 1 to 100.
Default
251 to 100cursorstringThe
next_cursorof the previous page.Up to 300 characters
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Responses
200A page of endpoints.
dataarray of WebhookEndpointRequiredThis page of results.
WebhookEndpoint fields
idstring (uuid)RequiredEndpoint id.
urlstringRequiredWhere events are POSTed.
descriptionstringRequiredYour note.
eventsarray of stringRequiredEvents it gets.
enabledbooleanRequiredWhether deliveries are sent.
created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
has_morebooleanRequiredWhether there are more results after this page.
next_cursorstring or nullRequiredPass as
cursorto get the next page; null on the last page.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl https://api.assistcall.ai/v1/webhooks \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"data": [
{
"id": "8b4f0d2a-6e9c-4a1b-8c3d-5e7a9c1e3d13",
"url": "https://example.com/assistcall/webhook",
"description": "CRM sync",
"events": [
"call.completed",
"appointment.booked"
],
"enabled": true,
"created_at": "2026-10-25T15:04:05.000Z",
"updated_at": "2026-10-25T15:04:05.000Z"
}
],
"has_more": false,
"next_cursor": null
}Add a webhook endpoint
/v1/webhooksScopewebhooks:write
The URL must be HTTPS on a public address (no private networks or credentials in the URL). Up to 10 endpoints per account (400 endpoint_limit). The response has the signing secret: it's the only time it's returned, so store it. See "Webhooks" for how deliveries are signed and retried.
Partner keys send the client's account id in AssistCall-Account.
Sandbox keys get 403 sandbox_read_only.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Request body
urlstring (uri)RequiredAn HTTPS URL on a public address.
Up to 500 charactersAt least 8 characters
descriptionstringYour note.
Up to 120 characters
eventsarray of stringRequiredEvents to send.
enabledbooleanWhether deliveries are sent.
Default
true
Responses
201The endpoint, with its signing secret.
idstring (uuid)RequiredEndpoint id.
urlstringRequiredWhere events are POSTed.
descriptionstringRequiredYour note.
eventsarray of stringRequiredEvents it gets.
enabledbooleanRequiredWhether deliveries are sent.
created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
secretstringRequiredThe signing secret (
whsec_…). Only returned when the endpoint is created.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl -X POST https://api.assistcall.ai/v1/webhooks \
-H "Authorization: Bearer $ASSISTCALL_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/assistcall/webhook",
"description": "CRM sync",
"events": [
"call.completed",
"appointment.booked"
]
}'Example response (201)
{
"id": "8b4f0d2a-6e9c-4a1b-8c3d-5e7a9c1e3d13",
"url": "https://example.com/assistcall/webhook",
"description": "CRM sync",
"events": [
"call.completed",
"appointment.booked"
],
"enabled": true,
"created_at": "2026-10-25T15:04:05.000Z",
"updated_at": "2026-10-25T15:04:05.000Z",
"secret": "whsec_3kP9mQ2vX7rT1bN8cL4dF6hJ0sA5gW2e"
}Get a webhook endpoint
/v1/webhooks/{id}Scopewebhooks:read
Partner keys send the client's account id in AssistCall-Account.
Path parameters
idstring (uuid)RequiredThe webhook endpoint's id.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Responses
200The endpoint.
idstring (uuid)RequiredEndpoint id.
urlstringRequiredWhere events are POSTed.
descriptionstringRequiredYour note.
eventsarray of stringRequiredEvents it gets.
enabledbooleanRequiredWhether deliveries are sent.
created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl https://api.assistcall.ai/v1/webhooks/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"id": "8b4f0d2a-6e9c-4a1b-8c3d-5e7a9c1e3d13",
"url": "https://example.com/assistcall/webhook",
"description": "CRM sync",
"events": [
"call.completed",
"appointment.booked"
],
"enabled": true,
"created_at": "2026-10-25T15:04:05.000Z",
"updated_at": "2026-10-25T15:04:05.000Z"
}Change a webhook endpoint
/v1/webhooks/{id}Scopewebhooks:write
Only the fields you send change. events replaces the list; enabled: false pauses deliveries.
Partner keys send the client's account id in AssistCall-Account.
Sandbox keys get 403 sandbox_read_only.
Path parameters
idstring (uuid)RequiredThe webhook endpoint's id.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Request body
urlstring (uri)An HTTPS URL on a public address.
Up to 500 charactersAt least 8 characters
descriptionstringYour note.
Up to 120 characters
eventsarray of stringEvents to send (replaces the list).
enabledbooleanWhether deliveries are sent.
Responses
200The endpoint.
idstring (uuid)RequiredEndpoint id.
urlstringRequiredWhere events are POSTed.
descriptionstringRequiredYour note.
eventsarray of stringRequiredEvents it gets.
enabledbooleanRequiredWhether deliveries are sent.
created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl -X PATCH https://api.assistcall.ai/v1/webhooks/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
-H "Authorization: Bearer $ASSISTCALL_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"events": [
"call.completed",
"message.taken"
],
"enabled": true
}'Example response (200)
{
"id": "8b4f0d2a-6e9c-4a1b-8c3d-5e7a9c1e3d13",
"url": "https://example.com/assistcall/webhook",
"description": "CRM sync",
"events": [
"call.completed",
"message.taken"
],
"enabled": true,
"created_at": "2026-10-25T15:04:05.000Z",
"updated_at": "2026-10-25T15:04:05.000Z"
}Remove a webhook endpoint
/v1/webhooks/{id}Scopewebhooks:write
Deliveries still queued for it are dropped.
Partner keys send the client's account id in AssistCall-Account.
Sandbox keys get 403 sandbox_read_only.
Path parameters
idstring (uuid)RequiredThe webhook endpoint's id.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Responses
200Removed.
idstring (uuid)RequiredThe id of what was removed.
deletedbooleanRequiredAlways true.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl -X DELETE https://api.assistcall.ai/v1/webhooks/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"id": "8b4f0d2a-6e9c-4a1b-8c3d-5e7a9c1e3d13",
"deleted": true
}Send a test event
/v1/webhooks/{id}/testScopewebhooks:write
Sends a sample event (with data.test: true), signed like a real one, and reports what the endpoint answered. Test events aren't retried, and a key can send 10 a minute (429 test_rate_limited). Without event, the endpoint's first event type is used. The body can be empty.
Partner keys send the client's account id in AssistCall-Account.
Sandbox keys get 403 sandbox_read_only.
Path parameters
idstring (uuid)RequiredThe webhook endpoint's id.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Request body
eventstringWhich sample event to send.
One of:
call.completed,message.taken,appointment.booked,appointment.rescheduled,appointment.canceled,lead.captured
Responses
200What happened.
deliveryobjectRequiredFields
idstring (uuid)RequiredDelivery id (the X-AssistCall-Delivery header).
eventstringRequiredThe event sent.
One of:
call.completed,message.taken,appointment.booked,appointment.rescheduled,appointment.canceled,lead.capturedstatusstringRequireddelivered: the endpoint answered 2xx.
One of:
delivered,failedresponse_statusinteger or nullRequiredThe HTTP status the endpoint answered.
errorstring or nullRequiredWhy it failed.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl -X POST https://api.assistcall.ai/v1/webhooks/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e/test \
-H "Authorization: Bearer $ASSISTCALL_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"event": "call.completed"
}'Example response (200)
{
"delivery": {
"id": "2c6e0a4b-8d1f-4b3a-9e5c-7a9c1e3a5f24",
"event": "call.completed",
"status": "delivered",
"response_status": 200,
"error": null
}
}