POST /api/v2/subscriptions/channel
Creates a Channel event subscription. An endpoint_id is required so that we know to which url the events shall be sent. A channel direction is also required in order to limit the direction for which events are sent. Use 'all' to get channel events for all directions. A target_id must be provided and it must be a Channel target.
Added on Jul 30th, 2024 for API v2.
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 |
Null | Yes |
The message direction this event subscription subscribes to. Valid values:
|
endpoint_id |
Integer | Yes |
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 |
target_id |
Integer | Yes |
The ID of the specific target for which events should be sent. |
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.