FAfax
Webhooks

List user webhooks (Legacy)

Legacy GET /hooks. Prefer GET /webhooks. Returns a list of currently registered webhooks for the requested event. (Permitted scopes: fax:all:read, fax:webhook:read)

get/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

Query parameters

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

Webhook event type

Response

Response containing a list of currently registered webhooks

Example response

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

Changes

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