API Reference

Agent Status -- Create

post
https://dialpad.com/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.

Body Params
string | null
enum
required

The agent type this event subscription subscribes to.

Allowed:
boolean | null
Defaults to true

Whether or not the this agent status event subscription is enabled.

int64 | null

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

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