Skip to main content
Automation rules can talk to systems outside Equip. The Notify an external system (webhook) action sends candidate details to a URL you choose, and the An external system sends an update trigger lets that system report back, for example when a background check clears.
These webhooks are set per rule, on a pipeline stage. For team-wide notifications when a candidate completes an assessment or AI interview, see Webhooks instead.

Add a Webhook Action

1

Open the rule

In the job’s Settings, under Candidate Pipeline, open the stage’s Automation dialog and create or expand a rule.
2

Add the action

Click Add action and choose Notify an external system (webhook).
3

Enter the method and URL

Pick GET, POST, PUT, or PATCH (POST is the default) and enter your endpoint. The URL must start with https://.
4

Add headers

Expand Headers to add any your endpoint needs, such as an Authorization header. A Content-Type: application/json header is included to start with.
5

Save

Click Save in the dialog.
Header values are stored with the rule and are visible to every recruiter on your team who opens it. Use a token that is scoped to this integration only.

The Payload

Every webhook sends the same JSON structure. There is no payload editor; if your system needs more detail, it can fetch it with the Equip API.

Send an Update Back

To report a result to Equip, your system sends a POST request to the callback_url it received in the webhook.
Two kinds of rule can react to the update. A rule with the An external system sends an update trigger runs when the update arrives, and a rule with Status changes to runs when the status becomes the one you picked.
The external update trigger can only be used on a stage where some rule fires a webhook. The webhook is how the external system receives its callback address.
The callback address needs no other login, expires, and can be used once. Treat it as a secret, and send text or references in data, not files or media.

Example: A Background Check Stage

A Custom stage with its own statuses can run a full hand-off without anyone clicking a button. The background check provider receives the webhook, runs the check, and posts the matching status to the callback address. To set up the statuses, see Automation Triggers, Conditions, and Actions.