Callbacks

TeXML Conference Join

Webhook sent when a participant joins a TeXML conference. This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.

postWebhookTexmlConferenceJoinWebhook

Headers

telnyx-timestampinteger required

Unix timestamp for replay attack prevention

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

telnyx-signature-ed25519string required

Ed25519 signature of timestamp|payload for verification

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature

Payload application/x-www-form-urlencoded

AccountSidstring required

The unique identifier of the account (user_id).

CallSidstring required

The unique identifier of the call that joined.

CallSidLegacystring required

Legacy call identifier, same as CallSid.

CallingPartyTypestring

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

ConferenceSidstring required

The unique identifier of the conference.

ConnectionIdstring required

The unique identifier of the connection.

FriendlyNamestring required

The friendly name of the conference.

Fromstring

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

FromSipUristring

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

ParticipantLabelstring

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

SequenceNumberinteger required

The sequence number of the event.

StatusCallbackEvent'participant-join' required

The event that triggered the callback.

Timestampstring date-time required

The UTC timestamp when the webhook was generated.

Tostring

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

ToSipUristring

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

Example payload

{
  "AccountSid": "f5586561-8ff0-4291-a51b-c7dfe4139ff9",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallingPartyType": "customer",
  "ConferenceSid": "conf_abc123def456",
  "ConnectionId": "1234567890",
  "FriendlyName": "MyConference",
  "From": "+35319605860",
  "FromSipUri": "sip:user@example.com",
  "ParticipantLabel": "participant-1",
  "StatusCallbackEvent": "participant-join",
  "Timestamp": "2024-01-15T10:31:00Z",
  "To": "+13129457420",
  "ToSipUri": "sip:conference@example.com"
}

Response

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

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.