API Reference

Fax Event -- Create

post
https://dialpad.com/api/v2/subscriptions/fax

Creates a fax event subscription. An endpoint_id is required so that we know to which url the events shall be sent. A fax direction is also required in order to limit the direction for which fax events are sent. Use 'all' to get fax events for all directions. A target_type and target_id may optionally be provided to scope the events only to fax to/from that target.

See https://developers.dialpad.com/docs/fax-events for details on how fax events work, including the payload structure and payload examples.

NOTE: API key needs to have the "fax_message" OAuth scope.

Added on Jan 12th, 2024 for API v2.

Requires scope: fax_message

Rate limit: 1200 per minute.

Body Params
string | null
enum
required

The fax direction this event subscription subscribes to.

Allowed:
boolean | null
Defaults to true

Whether or not the fax event subscription is enabled.

int64 | null

The logging endpoint's ID, which is generated after creating a webhook or websocket successfully.

boolean | null
Defaults to false

Whether or not to update on each fax message status.

int64 | null

The ID of the specific target for which events should be sent.

string | null
enum

The target's type.

Allowed:
Response

Updated 4 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago