FAfax
Webhooks

Create a webhook endpoint

Changed on

Create a webhook endpoint. url and filter_types (min 1) are required. Returns 201 with an empty body. Requires webhooks to be enabled in Integrations. (Permitted scopes: fax:all:edit, fax:webhook:edit)

post/webhooks

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/webhooks
  • 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

urlstring required
filter_typesWebhookFilterType[] required
channelsstring[] nullable
descriptionstring
disabledboolean
headersobject
throttle_rateinteger

Response

Endpoint was successfully created. Body is an empty object; list endpoints to read the ep_… id.

object required

Changes