Web Hooks
A webhook tells your own systems when something happens in CheckFlow. You subscribe a URL to an event; when the event occurs, CheckFlow sends an HTTP POST to that URL with a JSON body describing what happened.
Webhooks are the right choice when you want CheckFlow to push work into a system you control, and you do not want to poll the API asking whether anything has changed.
Events You Can Subscribe To
| Event | Fires when |
|---|---|
new_checklist | A checklist is created from a specific template. |
task_completed | A task is completed. Can be scoped to one task, to any task in one template, or to the whole team. |
file_uploaded | A file is uploaded through a specific File Upload control. |
data_set.record.created | A record is added to any Data Set in the team. |
data_set.record.updated | A Data Set record's values change. |
data_set.record.deleted | A Data Set record is deleted. |
The three Data Set events are always team-wide. The first three are scoped by the keys you supply when subscribing.
Setting One Up
Subscriptions are created through the API, not the interface. The Webhooks API reference documents the endpoints, every parameter, the scope rules for task_completed, and the JSON payload each event sends.
You will need an API key first — see API Reference.
Webhooks or Zapier?
| Webhooks | Zapier | |
|---|---|---|
| Needs code | Yes — you host the endpoint that receives the POST | No |
| Goes to | Any URL you control | Several thousand pre-built apps |
| Best for | Your own systems, and anything Zapier does not reach | Connecting to a service Zapier already supports |
Zapier uses webhooks underneath. If Zapier already connects to the service you have in mind, use it and skip the hosting.
Related Pages
- Webhooks API — the endpoint reference, parameters, scope rules and payloads.
- Zapier — the same events without writing or hosting anything.
- Custom Notifications — for notifying people rather than systems.
- API Reference — generating the API key a subscription needs.