POST /api/v2/subscriptions/agent_status
Creates an agent status event subscription for your company. A webhook_id is required so that we know to which url the events shall be sent. Please be aware that only call center agent is supported for agent event subscription now.
See https://developers.dialpad.com/docs/agent-status-events for details on how agent status events work, including the payload structure and payload examples.
Added on May 7th, 2021 for API v2.
Requires a company admin API key.
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 |
|---|---|---|---|
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 this agent status event subscription is enabled. Default value: true |
agent_type |
String | Yes |
The agent type this event subscription subscribes to. Possible 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.