Overview
Overview is the home page. At the top, one status line says whether something needs you. Below it:
- Set up your workspace, for new workspaces: three steps (Send a test webhook, Schedule your first real webhook, Connect your app) that tick themselves when done.
- Incidents: webhooks that failed for good and still need someone. Each has Review; when other scheduled webhooks use the same failing URL, the status line offers Fix N webhooks (see Fix and resend).
- The last days in numbers (Delivered, Delivery rate, Canceled, Median response) and Recent deliveries.
Schedule a webhook from the dashboard
Click Schedule webhook on the Overview. The form has:
- Start from a template (optional): a ready payload for common cases.
- Destination: the method (POST by default) and the URL. Test URL now sends one request immediately and shows the answer, without scheduling anything.
- Payload: the JSON body.
- When: a date and time in your browser’s time zone (shown next to the label), or +5 min, +1 hour, Tomorrow.
- Advanced: Reference (your own ID, to find or cancel it from the API) and Criticality (Standard, Important, Critical: alerts can be limited to the important ones).
Jobs
Jobs lists every webhook, newest first, with its Destination, Status, Schedule (UTC) and Latest attempt. Search deliveries, or filter by Status, Event type, Created date and More filters (criticality). The ··· menu on a row has the actions of the next sections, plus Copy job ID.
Jobs only lists webhooks still in your history: finished jobs are deleted after 7 days on Free, 30 on Pro and 90 on Scale.
Statuses
The dashboard and the API name statuses differently. The API value is what GET /api/v1/jobs returns.
PENDINGPROCESSINGRETRYINGSUCCESSFAILEDCANCELEDRecovered is a Delivered job that needed more than one attempt. Its API value is SUCCESS.
A job’s page
Click a row in Jobs to open it. From top to bottom:
- The method, the destination, Copy job ID and the actions for its status.
- Four facts: Scheduled for (or Next retry), Attempts, Last result, Current state.
- For a failure, a panel naming the problem, what it means and the next step (the same text as Troubleshooting).
- Delivery timeline: each attempt with its status code, duration, error and response body (the first 1,500 characters).
- Request: the payload and headers that are sent.
- Details: reference, criticality, idempotency key, created and updated times, and the alerts sent for this job.
- Schedule this from your app (folded): Node.js code that schedules this same webhook from your backend and cancels it.
Actions by status
Edit and reschedule and Run again create a new job with a new ID; the original stays in history. Each counts toward your monthly quota. More in Fix and resend.
Alerts and Inbox
In Settings → Alerts, choose when you get an email:
The first one is the default. Which webhooks limits emails to Important and Critical ones, Sent to shows the address, and Send me a test alert shows what one looks like. An alert email names the problem, how to fix it, and links to the job (or to Fix N webhooks when others share the URL).
Inbox
Inbox keeps the same events inside the dashboard: failures, recoveries, quota warnings and security events.
API keys
API keys creates and revokes keys. A key is shown once, when you create it. Every key has full access to the workspace. Free allows 1 active key, Pro 10, Scale 50. More in Account and API keys.
Signing secret
Settings → Security → Webhook signing secret holds the secret behind the Webhook-Signature header of every delivery. Rotate replaces it: update your receivers at the same time. How to verify: Webhook signatures.