Webhooks

Back to Help

In addition to instantiating checklist templates manually, you can use webhooks to do it programatically. Use the Webhook action to generate a public webhook URL for an individual template.

The full URL should look something like this:

https://api.checklists.fyi/api/checklists/public/f92dd696-40cd-11ed-a297-5a39dbdb907d/instantiate

You can now use this URL to create instances of your template by making a POST request to it:

$ curl -X POST https://checklists.fyi/api/checklists/public/f92dd696-40cd-11ed-a297-5a39dbdb907d/instantiate
{
  "ID": 16,
  "text": "Daily Startup Checklist for Sep 30, 2022",
  (remaining JSON elided...)
}

Requests to a webhook URL can contain custom tokens as well.