Manage Webhooks

You can send an event from CheckFlow to another system — when a checklist starts, a task is completed, a record changes — by adding a webhook on the Webhooks tab of Team Management. The same tab shows every webhook in the team, including those made through the API and by Zapier, with each one's delivery history.

For what a webhook is and when to use one, see Web Hooks. For the payloads and the signature, see the Webhooks API.

Before You Start

• You must be an Administrator.
• You need an https address on the public internet that accepts a POST. Addresses on localhost or a private network, and addresses containing a username or password, are refused.

Add a Webhook

1. Open the Webhooks tab of Team Management.
2. Click Add webhook.
3. In When, choose the event. Its description appears underneath.
4. In For, choose what the webhook covers. The choices depend on the event:

Event	For can be
Checklist started	Checklists from one template
Checklist completed	Checklists from one template, or everything in the team
Task completed	One task, checklists from one template, or everything in the team
Task assigned	One task, checklists from one template, or everything in the team
Comment added	One task, or everything in the team
File uploaded	One file upload field
Data set record added, changed or deleted	Everything in the team

5. If you chose a template, task or field, pick it from the lists that appear. Only current, unarchived templates are offered.
6. In Send to, enter the address, such as https://example.com/hooks/checkflow.
7. Click Add webhook.
8. The Signing secret dialog opens. Copy the secret into the system receiving the webhook, so that it can check the CF-Signature header on each request, then click I have copied it.

warning

The signing secret is shown only once. If it is lost, create a new one — see Change a Webhook.

The Webhooks List

Column	Shows
Event	The event, and its code, such as task_completed.
Sends to	The address.
For	What the webhook covers: the whole workspace, or a template, task or field. Something since archived or deleted is marked so.
Status	Active, with how many events have failed in a row if any; Paused; or Switched off, with why and when.
Created	When it was added.

A webhook labelled Zapier was made by one of your Zaps. Zapier keeps it in step with the Zap, so the only change you can make to it here is Delete.

Change a Webhook

Open the … menu in the webhook's row:

Option	What it does
Change URL	Sends to a different address. The event, what it covers and the signing secret stay as they are.
Pause	Stops sending, after you confirm. Events that happen while it is paused are never sent.
Resume	Starts sending again, and clears the count of failures. Shown as Turn back on for a webhook CheckFlow switched off.
New signing secret	Creates a new secret, shown once. The old one keeps working for 24 hours alongside it, so the receiver can be updated without missing anything.
Delete	Removes the webhook, after you confirm.

To change the event or what a webhook covers, delete it and add a new one.

Check and Replay Deliveries

1. Click Deliveries in the webhook's row. Its delivery history opens, newest first.
2. To narrow the list, choose an outcome: delivered, failed, refused, pending or abandoned.
3. Click Details on a delivery to see where it was sent, the response, the problem if there was one, and the payload.
4. To send it again, click Replay. The same payload is sent with the same delivery id, so the receiver can tell it is a repeat.

Deliveries are kept for 30 days. A delivery can be replayed only while the webhook is active and no other attempt is queued.

What Happens Next

• A delivery that fails is tried again, up to five attempts over about two and a half hours. See Retries.
• A webhook that fails ten events in a row is switched off. Its status says Switched off, with the reason. Fix the receiving system, then click Turn back on. Changing the URL alone does not turn it back on.
• Deleting a webhook stops it straight away. Its delivery history can no longer be viewed, and is cleared within 30 days. Deleting a Zapier webhook stops that Zap receiving events — turn the Zap off in Zapier too.
• Every other Administrator is notified when you add or delete a webhook, or give one a new signing secret.

If It Does Not Work

What you see	Why	What to do
The address is refused	It is not https, is on localhost or a private network, or contains a username or password	Use an https address on the public internet.
Managed by Zapier	The webhook belongs to a Zap	Change or turn off the Zap in Zapier instead.
Replay is not offered	The webhook is paused or switched off, or another attempt is already queued	Resume the webhook, or wait for the queued attempt.
Deliveries are refused	The address broke the address rules when it was sent to	Fix the address. A refused delivery is not tried again.

Related Pages

• Web Hooks — what webhooks are, and webhooks or Zapier.
• Webhook Events — every event and its payload.
• Webhooks API — verifying the signature, and managing webhooks in code.