Skip to main content
WEBHOOK
agentCancelled
{
  "success": false,
  "type": "agent.cancelled",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "webhookId": "d4e5f6a7-0005-0000-0000-000000000000",
  "data": [
    {
      "creditsUsed": 3
    }
  ],
  "metadata": {}
}

Headers

​
X-Firecrawl-Signature
string

HMAC-SHA256 signature of the raw request body, formatted as sha256=<hex>. Present when an HMAC secret is configured in your account settings. See Webhook Security for verification details.

Example:

"sha256=abc123def456789..."

Body

application/json
​
success
boolean
required

Always false for this event.

​
type
string
required
Allowed value: "agent.cancelled"
​
id
string<uuid>
required

The agent job ID.

​
webhookId
string<uuid>
required

Unique identifier for this webhook delivery.

​
data
object[]
required
​
metadata
object

The custom metadata object you provided in the webhook configuration. Echoed back in every delivery.

Response

200

Return any 2xx status code to acknowledge receipt.