FAfax
Webhooks

Register new webhook (Legacy)

Legacy POST /hooks. Prefer POST /webhooks. 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

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/hooks
  • Auth
    • OAuth 2
      Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
      Token URL: https://accounts.fax.plus/token scopes: all
    • or HTTP bearer

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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.