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 disconnected. It carries two fields the connected event does not.

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

reason
enum<string>
required

Why the session ended. "logged out from Timelines" - the number was disconnected in Timelines. "logged out from another device" - the phone dropped the companion, through Linked devices or by enabling coexistence; this is not a ban. "banned" - WhatsApp locked the primary device. "other" - anything else.

Available options:
logged out from Timelines,
logged out from another device,
banned,
other
Example:

"logged out from another device"

details
string
required

Free text about the same event, empty when there is none. Not meant to be parsed - it is there to be read.

Example:

"401: logged out from another device"

disconnected_at
string<date-time>
Example:

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

Response

200

Receiver accepted the event