Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Talkdesk

Talkdesk Webhook Surface

AsyncAPI 2.6 description of Talkdesk's publicly documented outbound webhook surface,covering the Events API (partner-app lifecycle), the Webhook Trigger API (TalkdeskConnections triggers for call/agent/contact/note events), and the AutomatedNotifications bridge for Digital Connect (DCE). Only event types that appear indocs.talkdesk.com are modeled. Frequently-asked-about events such asrecording_available and agent_status_change are not documented as standard eventtypes on the public docs site and are intentionally not included.

Documentation Provider Profile APIs.io AsyncAPI GitHub

Talkdesk Webhook Surface is published by Talkdesk on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Webhooks, Events, AsyncAPI, Partner Apps, and Connections. The published artifact set on APIs.io includes API documentation, an API reference, and an AsyncAPI specification.

This event API exposes 18 operations across 18 channels, and defines 31 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through 3 servers: {partnerCallbackUrl} (https), {connectionsCallbackUrl} (https), api.talkdeskapp.{region} (https).

18 operations 18 channels 31 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0
Servers
{partnerCallbackUrl} (https)
{connectionsCallbackUrl} (https)
api.talkdeskapp.{region} (https)
Contact
Talkdesk Developer Support
Resource Areas
1

Channels & Operations 18

Across 18 channels, the API surfaces 18 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 18
PUB
partner-events/app.installed
app.installed lifecycle event
onAppInstalled body
PUB
partner-events/app.updated
app.updated lifecycle event
onAppUpdated body
PUB
partner-events/app.uninstalled
app.uninstalled lifecycle event
onAppUninstalled body
PUB
partner-events/app.trial_started
app.trialstarted lifecycle event
onAppTrialStarted body
PUB
partner-events/app.trial_extended
app.trialextended lifecycle event
onAppTrialExtended body
PUB
partner-events/app.trial_ended
app.trialended lifecycle event
onAppTrialEnded body
PUB
partner-events/app.credentials_rotated
app.credentialsrotated lifecycle event
onAppCredentialsRotated body
PUB
partner-events/user.logout
user.logout lifecycle event
onUserLogout body
PUB
webhook-trigger/contact-created
Webhook trigger - contact created
onContactCreated body
PUB
webhook-trigger/contact-updated
Webhook trigger - contact updated
onContactUpdated body
PUB
webhook-trigger/note-created
Webhook trigger - note created
onNoteCreated body
PUB
webhook-trigger/agent-logged-in
Webhook trigger - agent logs in
onAgentLoggedIn body
PUB
webhook-trigger/agent-logged-out
Webhook trigger - agent logs out
onAgentLoggedOut body
PUB
webhook-trigger/inbound-call-reaches-contact-center
Webhook trigger - inbound call reaches contact center
onInboundCallReachesContactCenter body
PUB
webhook-trigger/inbound-call-starts
Webhook trigger - inbound call starts
onInboundCallStarts body
PUB
webhook-trigger/inbound-call-ends
Webhook trigger - inbound call ends
onInboundCallEnds body
PUB
webhook-trigger/outbound-call-ends
Webhook trigger - outbound call ends
onOutboundCallEnds body
PUB
automated-notifications/bridge/digital-connect
Automated Notifications bridge for Digital Connect
postDigitalConnectBridgeEvent body

Messages & Schemas 31

The contract defines 31 schemas that model the data carried by its messages. The most detailed are DCEBridgeEnvelope (4 properties), EventsApiEnvelope (3 properties), EventsApiHeaders (2 properties). Each schema is shown below with its type and property counts.

AppInstalledEvent
message
Partner app was installed by a Talkdesk administrator.
AppUpdatedEvent
message
Partner app settings were updated.
AppUninstalledEvent
message
Partner app was uninstalled.
AppTrialStartedEvent
message
Trial of the partner app started.
AppTrialExtendedEvent
message
Trial of the partner app was extended.
AppTrialEndedEvent
message
Trial of the partner app expired or was ended.
AppCredentialsRotatedEvent
message
Partner app credentials were rotated by Talkdesk.
UserLogoutEvent
message
User belonging to an installation logged out.
ContactCreatedEvent
message
Webhook Trigger fired when a contact is created.
ContactUpdatedEvent
message
Webhook Trigger fired when a contact is updated.
NoteCreatedEvent
message
Webhook Trigger fired when a note is created.
AgentLoggedInEvent
message
Webhook Trigger fired when an agent logs in.
AgentLoggedOutEvent
message
Webhook Trigger fired when an agent logs out.
InboundCallReachesContactCenterEvent
message
Webhook Trigger fired when an inbound call reaches the contact center.
InboundCallStartsEvent
message
Webhook Trigger fired when an inbound call starts.
InboundCallEndsEvent
message
Webhook Trigger fired when an inbound call ends.
OutboundCallEndsEvent
message
Webhook Trigger fired when an outbound call ends.
DCEConversationEndedEvent
message
Digital Connect conversation ended.
DCEMessageCreatedEvent
message
Digital Connect message created in a conversation.
EventsApiHeaders
object
HTTP headers Talkdesk sets on Events API webhook deliveries.
2 properties
EventsApiEnvelope
object
Base envelope shape documented for Events API webhook payloads. Each delivered event contains an eventid (used for deduplication), an id, and a data object who…
3 properties 3 required
AppInstalledPayload
object
AppUpdatedPayload
object
AppUninstalledPayload
object
AppTrialStartedPayload
object
AppTrialExtendedPayload
object
AppTrialEndedPayload
object
AppCredentialsRotatedPayload
object
UserLogoutPayload
object
WebhookTriggerEnvelope
object
Generic envelope for payloads delivered by the Webhook Trigger API. The Talkdesk public documentation lists the nine supported trigger types but does not publi…
DCEBridgeEnvelope
object
Request body accepted by the Automated Notifications bridge for Digital Connect (DCE).
4 properties 3 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

talkdesk-webhooks-asyncapi.yml Raw ↑
#Webhooks#Events#AsyncAPI#Partner Apps#Connections#Digital Connect
← Back to T APIs
API Details
ID
talkdesk:webhooks
Server
{partnerCallbackUrl} (https)
Docs
https://docs.talkdesk.com/docs/events-api
Provider
Talkdesk
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network