Skip to main content
Firecrawl Docs

Agent Action

1 min read
webhookagentAction
webhookagentAction

Headers

X-Firecrawl-Signaturestring#
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.

Body

application/json
successenum<boolean>required#
Options:true
typeenum<string>required#
Options:agent.action
idstringrequired#
The agent job ID.
webhookIdstringrequired#
Unique identifier for this webhook delivery.
dataobject[]required#
Array with a single object describing the action taken.
Show child attributes
creditsUsednumber#
Estimated credits consumed so far. The final count is only available in the terminal event (completed, failed, or cancelled).
actionstring#
The tool that was executed, e.g. scrape, search, extract.
inputobject#
The input parameters passed to the tool.
metadataobject#
The custom metadata object you provided in the webhook configuration. Echoed back in every delivery.
Show child attributes
{key}string#

Responses

200
Return any 2xx status code to acknowledge receipt.
Agent StartedAgent Completed