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 the messaging quota for a workspace reaches or exceeds 90 or 100 percent utilization within the current billing period.

​
workspace_id
string
required

Identifier of the workspace whose messaging quota is nearing full utilization or reached.

Example:

"my-workspace"

​
event_type
enum<string>
required

Partner webhook event name.

Available options:
workspace:quota_near_full:messaging,
workspace:quota_full:messaging
Example:

"workspace:quota_full:messaging"

​
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"

​
messaging_quota_total
integer
required

Total messaging quota allocated to the workspace for the current billing period.

Example:

100000

​
messaging_quota_used
integer
required

Number of messaging units consumed in the current billing period when the threshold was reached.

Example:

90000

​
current_period_start
string<date-time>
required

Start of the current billing period used to aggregate the utilization

Example:

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

​
current_period_end
string<date-time>
required

End of the current billing period used to aggregate the utilization

Example:

"2024-01-31T23:59:59.000Z"

​
utilization_pct
integer

Messaging quota utilization percentage at the time of triggering, computed as an integer 0–100.

Example:

90

Response

200

Receiver accepted the event