Appearance
Webhook
Platform settingsAutomationWebhooksWebhookPermission:
settings.integrations.vieworsettings.integrations.manageAlso known as
- webhook deliveries
- delivery log
- send test
- test webhook
- retry
- failed delivery
- edit webhook
- rotate secret
- pause webhook
- HTTP response
The webhook page shows one webhook: where it sends, which events, its signing secret, and the log of every delivery with the receiving system's answer. Use it to test an endpoint, find out why deliveries fail, pause a webhook or change its secret.
Read the webhook
Open it from SettingsWebhooks. The title is the endpoint's host name, with Active or Paused next to it; the line below shows the number of events and when it was added.
The Configuration panel lists the full Endpoint, the Events, the start of the Signing secret and the Last delivery.
When recent deliveries fail, a banner says Recent deliveries are failing. Check the endpoint, then send a test.
Send a test
- Select Send test. Roari ERP sends a test event to the endpoint.
- You see Test delivered with the HTTP status and time, or Test delivery failed with the error.
- The test appears in Deliveries.
Read the delivery log
Deliveries lists every attempt, newest first. Filter with Result (Succeeded, Failed, Pending) or search by event.
| Column | Meaning |
|---|---|
| Result | Succeeded (the endpoint answered 2xx), Failed, or Pending (waiting to be sent or retried). |
| Event | The event sent. |
| Response | The HTTP status the endpoint returned. |
| Attempt | Which try this was; failures are retried automatically. |
| Time | How long the endpoint took to answer. |
| Sent | Date and time of the attempt. |
| Error | Why it failed, for example timeout after 10s or a connection error. |
| Typical error | What to do |
|---|---|
| Timeout | The endpoint took more than 10 seconds. Answer first, then process the message in the background. |
| 401 or 403 | The receiving system rejects the request: check its authentication and the signature check. |
| 404 | The address is wrong: select Edit and correct the Endpoint URL. |
| 5xx | The receiving system has an error; it is retried automatically. |
Edit, pause or rotate the secret
- Select Edit. The Edit webhook drawer opens with the same fields as when you added it (see Webhooks).
- Change the Endpoint URL or Events; turn Active off to pause it.
- To change the secret, select the arrows icon next to Signing secret. A warning reminds you that after saving, deliveries are signed with the new secret: update the receiving system at the same time.
- Select Save webhook. You see Webhook saved.
Delete a webhook
- Select Delete.
- Confirm Delete webhook in Delete this webhook?. You see Webhook deleted.
The endpoint stops receiving events immediately and its delivery log is deleted too. Workflow rules that call it must be changed.
Differences by role
- Viewing needs Permission:
settings.integrations.view; Send test, Edit and Delete needPermission:settings.integrations.manage.
