Skip to main content
WEBHOOK

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-TL-Partner-Id
string
required

The unique identifier for the partner.

​
X-TL-Signature
string
required

a JSON Web Token (JWT) token that contains the partner_id, nbf (not before), and exp (expiration) fields. using the partner''s shared secret and can be used to verify authenticity and integrity.

Body

application/json

Webhook payload sent when a WhatsApp account is successfully connected / disconnected for a user in a partner-managed workspace. No event is emitted for idempotent no-op operations (for example when the account is already connected / disconnected).

​
workspace_id
string
required

Identifier of the workspace where the WhatsApp account was connected / disconnected.

Example:

"my-workspace"

​
event_type
enum<string>
required

Partner webhook event name.

Available options:
whatsapp_account:connected,
whatsapp_account:disconnected
Example:

"whatsapp_account:disconnected"

​
partner_id
string
required

Unique identifier of the partner that owns the workspace.

Example:

"partner_12345"

​
triggered_at
string<date-time>
required

Timestamp when the event was triggered.

Example:

"2024-01-01T12:00:00.000Z"

​
whatsapp_account_id
integer
required

Internal WhatsApp account identifier.

Example:

67890

​
phone_number_e164
string
required

Phone number associated with the WhatsApp account in E.164

Example:

"+123456789"

​
user_id
integer
required

Identifier of the user in the workspace who owns the WhatsApp

Example:

98765

​
disconnected_at
string<date-time>
Example:

"2024-01-01T12:00:00.000Z"

​
reason
string
Example:

"(logged out)"

Response

200

Receiver accepted the event