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 all purchased seats in a workspace are utilized (available seats reach zero). This event is emitted once per billing period when the condition seats_utilized >= seats_purchased becomes true.

workspace_id
string
required

Identifier of the workspace whose seat utilization reached the purchased limit.

Example:

"my-workspace"

event_type
enum<string>
required

Partner webhook event name.

Available options:
workspace:seats_full
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 threshold condition was first met for the current billing period.

Example:

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

seats_purchased
integer
required

Number of seats purchased for the workspace in the current billing period.

Example:

10

seats_available
integer
required

Number of seats still available for assignment in the workspace.

Example:

10

Response

200

Receiver accepted the event