v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Webhooks

Register new webhook

Register a new webhook which will be called on a specific event. See the WebhookCallback model. (Permitted scopes: fax:all:edit, fax:webhook:edit)

post/hooks

Request body

idstring

Webhook ID

targetstring required

Webhook target URL

event'fax_received' | 'fax_sent' | 'fax_page_received' required

Webhook event type

numbersstring[] nullable

A list of phone numbers used to filter webhook triggers. If specified, the webhook will only fire for inbound or outbound calls involving these numbers. Pass null to disable filtering. An empty array is invalid

Example request

{
  "target": "http://myapp.com/fax_received",
  "event": "fax_received"
}

Response

Webhook ID

idstring required

Webhook ID

Example response

{
  "id": "6048b47181dbe1a7d67fcc98"
}