Skip to main content
WEBHOOK
TexmlConferenceLeaveWebhook
{
  "AccountSid": "f5586561-8ff0-4291-a51b-c7dfe4139ff9",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "ConferenceSid": "conf_abc123def456",
  "ConnectionId": "1234567890",
  "FriendlyName": "MyConference",
  "SequenceNumber": 4,
  "StatusCallbackEvent": "participant-leave",
  "Timestamp": "2024-01-15T11:00:00Z",
  "CallingPartyType": "customer",
  "From": "+35319605860",
  "FromSipUri": "sip:user@example.com",
  "ParticipantLabel": "participant-1",
  "To": "+13129457420",
  "ToSipUri": "sip:conference@example.com"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
telnyx-timestamp
integer<int64>
required

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp Unix timestamp for replay attack prevention

​
telnyx-signature-ed25519
string
required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/x-www-form-urlencoded

Webhook sent when a participant leaves a TeXML conference.

​
AccountSid
string
required

The unique identifier of the account (user_id).

Example:

"f5586561-8ff0-4291-a51b-c7dfe4139ff9"

​
CallSid
string
required

The unique identifier of the call that left.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

​
CallSidLegacy
string
required

Legacy call identifier, same as CallSid.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

​
ConferenceSid
string
required

The unique identifier of the conference.

Example:

"conf_abc123def456"

​
ConnectionId
string
required

The unique identifier of the connection.

Example:

"1234567890"

​
FriendlyName
string
required

The friendly name of the conference.

Example:

"MyConference"

​
SequenceNumber
integer
required

The sequence number of the event.

Example:

4

​
StatusCallbackEvent
enum<string>
required

The event that triggered the callback.

Available options:
participant-leave
Example:

"participant-leave"

​
Timestamp
string<date-time>
required

The UTC timestamp when the webhook was generated.

Example:

"2024-01-15T11:00:00Z"

​
CallingPartyType
string

The type of calling party (conditional, only present if available in event).

Example:

"customer"

​
From
string

The phone number or SIP address of the caller (conditional, only present if available in event).

Example:

"+35319605860"

​
FromSipUri
string

The SIP URI of the caller (conditional, only present if available in event).

Example:

"sip:user@example.com"

​
ParticipantLabel
string

The label of the participant (conditional, only present if available in event).

Example:

"participant-1"

​
To
string

The phone number or SIP address that was called (conditional, only present if available in event).

Example:

"+13129457420"

​
ToSipUri
string

The SIP URI of the callee (conditional, only present if available in event).

Example:

"sip:conference@example.com"

Response

200

The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.