GuidesAPI ReferenceDiscussionsKnowledge BaseAppConnectTalkdeskContacts

Subscribe to a New Stream

post https://api.talkdeskapp.com/live-subscriptions

You can get real-time data, via HTTP SSE notifications, available in Talkdesk Live (real-time live monitoring dashboard of a Talkdesk account activity).

The live dashboard metrics is available here.

📘

Supported Regions and Base URLs

Scope

live-subscriptions:write

live-subscriptions:read

Request Body

{
  "queries": [
    {
      "id": "7b8deafb74bf490288220fd3543b76af",
      "metadata": {
        "name": "arrived_contacts"
      },
      "params": [],
      "filters": {
        "ring_groups": [
          "agents"
        ],
        "range": {
          "type": "interval",
          "interval": 86400
        }
      }
    }
  ]
}
  • The response provides the representation of the newly created subscription with the description of its queries.
  • The relation stream provides the URL for an HTTP SSE client to connect, including the token of a subscription stream resource.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

❗️

Body Request Parameters

The body of the request consists of a parameter called queries, an array of objects that subdivides into id, metadata, params and filters.

Language
Click Try It! to start a request and see the response here!