Workspace and credit events

Every event arrives in the same envelope: only data changes. The examples are fictional, and indented here for reading; the request body is compact JSON.

credits.low

The credits used cross 80%, then 90%, of the period’s total. Data: credits (credits), with the threshold crossed (80 or 90).

Example: credits.low

{
  "id": "913ea9ac-cd7a-4ecb-8d79-6bef0da74460",
  "type": "credits.low",
  "created_at": "2026-10-06T08:10:07Z",
  "api_version": "2026-10-01",
  "workspace_id": "23e69bdb-4cd1-4822-802e-b38580e2f451",
  "data": {
    "credits": {
      "total": 10000,
      "used": 8050,
      "reserved": 0,
      "remaining": 1950,
      "available": 1950,
      "percent_used": 80.5,
      "period_start": "2026-08-31T15:02:42Z",
      "period_end": "2026-10-30T15:02:42Z",
      "threshold": 80
    }
  }
}

credits.exhausted

All the credits of the period are used: the agent stops collecting until you get more credits. Data: credits (credits).

Example: credits.exhausted

{
  "id": "470254c2-1b8e-49ce-87a4-a6fc688e577c",
  "type": "credits.exhausted",
  "created_at": "2026-10-06T08:10:07Z",
  "api_version": "2026-10-01",
  "workspace_id": "23e69bdb-4cd1-4822-802e-b38580e2f451",
  "data": {
    "credits": {
      "total": 10000,
      "used": 10000,
      "reserved": 0,
      "remaining": 0,
      "available": 0,
      "percent_used": 100,
      "period_start": "2026-08-31T15:02:42Z",
      "period_end": "2026-10-30T15:02:42Z"
    }
  }
}

billing.period_closed

A billing period ends. Sent once per period, within 4 hours of its end. Data: credits (credits) as the period ends, and closed_at.

Example: billing.period_closed

{
  "id": "081e0470-387e-4293-8a06-aa0dd51f3e08",
  "type": "billing.period_closed",
  "created_at": "2026-10-30T15:02:42Z",
  "api_version": "2026-10-01",
  "workspace_id": "23e69bdb-4cd1-4822-802e-b38580e2f451",
  "data": {
    "credits": {
      "total": 10000,
      "used": 6203,
      "reserved": 0,
      "remaining": 3797,
      "available": 3797,
      "percent_used": 62,
      "period_start": "2026-08-31T15:02:42Z",
      "period_end": "2026-10-30T15:02:42Z"
    },
    "closed_at": "2026-10-30T15:02:42Z"
  }
}

workspace.updated

Your workspace’s name, its score threshold or its automatic scoring changes. Data: workspace ({id, name, min_score, auto_qualify}) and changes: {name?, min_score?, auto_qualify?}, each {from, to}.

Example: workspace.updated

{
  "id": "3642de6a-144e-47f6-8efc-8b25bf05e3b6",
  "type": "workspace.updated",
  "created_at": "2026-10-06T08:10:07Z",
  "api_version": "2026-10-01",
  "workspace_id": "23e69bdb-4cd1-4822-802e-b38580e2f451",
  "data": {
    "workspace": {
      "id": "23e69bdb-4cd1-4822-802e-b38580e2f451",
      "name": "Acme Growth",
      "min_score": 4,
      "auto_qualify": true
    },
    "changes": {
      "min_score": {
        "from": 3,
        "to": 4
      }
    }
  }
}

Get started

Webhooks

Events

Workspace and credit events

credits.low

credits.exhausted

billing.period_closed

workspace.updated

​credits.low

​credits.exhausted

​billing.period_closed

​workspace.updated

credits.low

credits.exhausted

billing.period_closed

workspace.updated