workspaces

Triggered when the Public API calls quota for a workspace reaches or exceeds 100 percent utilization within the current billing period.

postWebhookworkspace:quota_full:api_calls

Headers

X-TL-Partner-Idstring required

The unique identifier for the partner.

X-TL-Signaturestring 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.

Payload

workspace_idstring required

Identifier of the workspace whose Public API calls quota has reached full utilization.

event_type'workspace:quota_full:api_calls' required

Partner webhook event name.

partner_idstring required

Unique identifier of the partner that owns the workspace.

triggered_atstring date-time required

Timestamp when the event was triggered.

api_calls_limitinteger required

Total number of Public API calls allocated to the workspace for the current billing period.

api_calls_usedinteger required

Number of Public API calls consumed in the current billing period when the threshold was reached.

current_period_startstring date-time required

Start of the current billing period used to aggregate the utilization

current_period_endstring date-time required

End of the current billing period used to aggregate the utilization

Example payload

{
  "workspace_id": "my-workspace",
  "event_type": "workspace:quota_full:api_calls",
  "partner_id": "partner_12345",
  "triggered_at": "2024-01-01T12:00:00Z",
  "api_calls_limit": 1000000,
  "api_calls_used": 1000000,
  "current_period_start": "2024-01-01T00:00:00Z",
  "current_period_end": "2024-01-31T23:59:59Z"
}

Response

Receiver accepted the event

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.