Send a Checkpoint to Slack or Teams by webhook
A Checkpoint can call a webhook as well as, or instead of, sending email. In the Checkpoint Alert panel, click Add webhook and enter a URL that starts with https://. Mammoth calls it when the Checkpoint triggers, for example to post to Slack, Teams, PagerDuty or your own endpoint. The request times out after 10 seconds.
What the Checkpoint webhook sends
The payload is fixed: you can't change it. Every Checkpoint webhook sends this JSON body in a POST request:
{
"checkpoint_id": 123,
"checkpoint_name": "Finance team approval before final report",
"checkpoint_type": "approval",
"task_sequence": 4,
"dataview_id": 654,
"dataview_name": "View 1",
"workspace_id": 22
}
checkpoint_type is "alert" or "approval".
Test that the webhook URL is reachable
- Click Payload under the webhook URL to open the payload editor.
- Write a test payload. Test turns on once the payload has content.
- Click Test. Your browser sends the draft to the URL.
- Read the result: Delivered · 200 or Endpoint returned an error.
The editor accepts these tokens: {{pipeline_name}}, {{pipeline_id}}, {{checkpoint_type}}, {{step_number}}, {{step_name}}, {{timestamp}}, {{status}}, {{project_name}} and {{triggered_by}}. Unknown tokens are sent as they are. The payload can be up to 10KB with up to 5 levels of nesting.
The test payload is never saved and doesn't change what is sent. A real trigger always sends the fixed payload above.
Troubleshooting Checkpoint webhooks
| Symptom | Cause | Fix |
|---|---|---|
| The webhook test shows Endpoint returned an error | The URL refused or failed the request | Check the URL and your endpoint, then test again |
Related
- Pause a pipeline for approval with a Checkpoint: add the Checkpoint the webhook belongs to.
- How the pipeline works: reruns, task order and previews.
- Fix a failing step: when a task errors instead of pausing.
Something wrong? support@mammoth.io