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
workspace_id
string
required
Example:

"my-workspace"

event_type
enum<string>
required

Partner webhook event name.

Available options:
workspace:quota_full:transactions
Example:

"workspace:quota_full:transactions"

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"

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"

Response

200

Receiver accepted the event