Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

A workspace API key from Settings → Developers → API keys, sent as Authorization: Bearer sk_… (or X-API-Key: sk_…). It acts as one workspace member and uses the workspace's credits.

Headers

webhook-id
string
required

The event id. The same on every retry of this event.

webhook-timestamp
string
required

When this attempt was signed, in Unix seconds. Reject events more than 5 minutes off.

webhook-signature
string
required

Space-separated v1,<base64 HMAC-SHA256> signatures, one per valid secret.

Body

application/json
id
string
required

Same as the webhook-id header.

type
enum<string>
required
Available options:
tool_invocation.completed,
tool_invocation.not_executed,
tool_invocation.unknown_outcome
createdAt
string<date-time>
required
data
object
required

The operation, exactly as GET /api/tool-invocations/{invocationId} returns it (without replayed and chargedThisRequest).

Response

Received. Any 2xx counts.