What are Webhooks?

Webhooks are automated messages sent from apps when something happens. They have a message—or payload—and are sent to a unique URL—on another server to communicate from application to application. More on understanding webhooks from our friends at Zapier.

What you can do with Webhooks

Want to update another system when a step in Manifestly is completed? Webhooks!

Want to send information to another server when a checklist is completed? Webhooks!

Events Available

  • Checklist start
  • Checklist complete
  • Step complete

Payload

When a web hook is called after one of these events, json will be sent formatted like the following. Things to note:

  • For every event, the full json for the checklist run as well as every step in the checklist is sent
  • For data collection, the data_values array is sent within each step

[{
"participants": "philip@manifest.ly, mark@manifest.ly, joserracamacho@gmail.com",
"checklist_name": "Step Data",
"completed_at": null,
"completed_by": null,
"completed_by_name": null,
"run_detailed_name": "Slack testing - Step Data",
"run_id": 958957,
"run_name": "Slack testing",
"run_url": "https://app.manifest.ly/runs/958957",
"external_id": null,
"tags": [],
"archive_url": "https://app.manifest.ly/runs/archives/f86c3bb3841e08deee2ac1f67ebb530b.pdf",
"started_at": "2020-08-15T17:44:46.686Z",
"late_at": null,
"run_steps": [{
"assigned_to": null,
"assigned_to_email": null,
"completed_at": null,
"completed_by": null,
"completed_by_name": null,
"late_at": null,
"run_step_id": 25104171,
"skipped": false,
"step_id": 335883,
"title": "Upload a file",
"data_values": [{
"value": null,
"id": 13396,
"data_13396": null,
"label": "Spreadsheet",
"required": true,
"format": "file",
"valid_values": null
}]
}, {
"assigned_to": null,
"assigned_to_email": null,
"completed_at": null,
"completed_by": null,
"completed_by_name": null,
"late_at": null,
"run_step_id": 25104172,
"skipped": false,
"step_id": 335885,
"title": "Upload an image",
"data_values": [{
"value": null,
"id": 13397,
"data_13397": null,
"label": "Image",
"required": true,
"format": "image",
"valid_values": null
}]
}, {
"assigned_to": null,
"assigned_to_email": null,
"completed_at": "2020-08-15T20:56:17.353Z",
"completed_by": "philip@manifest.ly",
"completed_by_name": "Philip Crawford",
"late_at": null,
"run_step_id": 25104173,
"skipped": false,
"step_id": 426102,
"title": "Choose from list",
"data_values": [{
"value": "red",
"id": 18342,
"data_18342": "red",
"label": "fave color",
"required": true,
"format": "list",
"valid_values": ["red", "orange", "blue", "green", "yellow", "indigo", "violet"]
}]
}, {
"assigned_to": null,
"assigned_to_email": null,
"completed_at": null,
"completed_by": null,
"completed_by_name": null,
"late_at": null,
"run_step_id": 25104175,
"skipped": false,
"step_id": 980933,
"title": "No data necessary",
"data_values": []
}]
}]

Did this answer your question?