Clarify API
Guides

Webhooks

Trigger automations from inbound HTTP requests and call out to your systems

Webhooks connect Clarify to the rest of your stack in both directions:

  • Inbound webhooks let an external system start a Clarify automation by sending it an HTTP request.
  • Outbound webhooks let a Clarify automation send an HTTP request to your system when something happens.

Both directions are available in workflows and in AI Agents. In workflows they're a trigger (inbound) and an action (outbound); in AI Agents they're a trigger (inbound) and a call your agent makes from code it runs (outbound).

Inbound webhooks

An inbound webhook gives an automation its own URL. Send an HTTP request to that URL and the automation runs, with your request body and headers available as input.

Set it up

  1. Open a workflow or an AI Agent and add the On inbound webhook trigger.
  2. Publish the workflow (or save the agent). Clarify generates the URL once the automation exists.
  3. Copy the generated URL from the trigger and paste it into the system that will call it.

Each automation gets its own URL, shaped like this:

https://api.clarify.ai/v1/webhooks/workflows/{workspace}/{workflow_id}
https://api.clarify.ai/v1/webhooks/agents/{workspace}/{agent_id}

Send a request

Send any JSON payload with a POST. No Authorization header is required: the URL itself is the credential, so treat it like a secret.

curl -X POST \
  https://api.clarify.ai/v1/webhooks/workflows/your-workspace/f2a4c6e8-0b1d-4e3f-8a5c-7d9e1f3a5b7c \
  -H 'Content-Type: application/json' \
  -d '{ "email": "jane@example.com", "plan": "enterprise" }'

Clarify responds with 200 OK as soon as it accepts the request, then runs the automation asynchronously.

Use the payload

Clarify passes both the request body and headers into the automation.

In a workflow, reference them with the variable syntax in any downstream block. For the request above:

{{trigger.state.event.data.body.email}}
{{trigger.state.event.data.headers.content-type}}

In an AI Agent, the body and headers are handed to the agent as context for the run, so you can instruct the agent to act on them in natural language.

Inbound webhook requests are rate-limited per automation. If you expect high volume, reach out at support@clarify.ai.

Outbound webhooks

An outbound webhook sends an HTTP request from a Clarify automation to a URL you choose: useful for notifying your systems, kicking off a job, or syncing a change elsewhere.

In a workflow

Add the Outbound webhook action and configure:

  • URL: the endpoint to call.
  • Method: GET, POST, PUT, PATCH, or DELETE.
  • Headers: any headers to send, such as authentication or Content-Type.
  • Body: the request body (for methods that send one).

The URL, headers, and body all support workflow variables, so you can interpolate values from the trigger or earlier blocks:

https://hooks.example.com/deals/{{trigger.state.event.object._id}}

For calls the fixed action can't express (building the payload dynamically, branching on the response, or chaining several requests), use the Execute code action instead and fetch the URL directly. See Build a workflow.

In an AI Agent

AI Agents make outbound calls by running code: the agent writes JavaScript that can fetch any URL. This gives it full control over the request (building the payload from what it found, branching on the response, and retrying) rather than a single fixed call.

On this page