POST /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.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
direction |
String | Yes |
The fax direction this event subscription subscribes to. Valid values:
|
endpoint_id |
Integer | No |
The logging endpoint's ID, which is generated after creating a webhook or websocket successfully. |
enabled |
Boolean | No |
Whether or not the fax event subscription is enabled. Default value: true |
status |
Boolean | No |
Whether or not to update on each fax message status. Default value: false |
target_id |
Integer | No |
The ID of the specific target for which events should be sent. |
target_type |
String | No |
The target's type. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.