Webhook triggers allows you to start a checklist from another system. Each webhook trigger have a unique URL that a third party system or service perform a request against to run the trigger and start a new checklist.
To add a webhook trigger start by adding a webhook trigger to the template.
On the trigger page you now see a URL, this is your unique webhook URL for this trigger.
To run the trigger you make a HTTP POST call the webhook URL.
Making a request to the webhook URL
curl -X POST \
https://webhook.firesub.com/webhooks/v0/61ab538162cb3cadbbde8c85a21df4610092fee004fc1f0ae687265825399113a446ab08335eeeb34d3e32ab192c3b463b07d506583c0cfa5ce15444ed00352f \
A successful request will return the following
content-type →application/json; charset=utf-8
{
"status": 200,
"message": "Triggered successful"
}
Supported request parameters
You can pass two parameters with the request, name and description. These can be passed either in the URL as parameters or in the body of the request.
The name parameter is the name of the new checklist started from the trigger. This means that if you pass the parameter name=New checklist from system x the checklist name will be New checklist from system x.
The same is true for the description parameter, if passed it will be used to set the description of the new checklist.
Both name and description parameters support naming formatting, so you can pass a format variable in the parameter. e.g. if you pass the parameter name=New checklist {YYYY} the name of the new checklist be New checklist 2017.