Platform › Events & Webhooks
Webhooks
Events pushed out to another system, signed with HMAC-SHA256 so the receiver can prove where they came from.
Where to find it
- Module: Platform
- Group: Connectivity
- Section: Events & Webhooks
- Screen: Webhooks
Address in the console: /platform/webhooks
List · 15 columns · 9 fields on its form · 2 of them required · 2 actions
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Webhook | Code | code |
| Name | Text | name |
| Direction | Status | direction |
| Target | Text | target_url |
| Events | Text | events |
| Signature | Code | signature_algo |
| Signing | Text | signing |
| Queued | Number | queued_count |
| Sent | Number | sent_count |
| Not sent | Number | not_sent_count |
| Waiting | Number | waiting_count |
| Success | Text | success_rate |
| Web-page answers | Number | web_page_count |
| Status | Status | status |
| Receiver warning | Text | host_warning |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Webhook code required | Text | ||
| Name required | Text | ||
| Direction | Choice | outbound, inbound | |
| Target URL | Text | ||
| Events | Text | Comma separated. A delivery for an event it does not subscribe to is refused. | |
| Signature algorithm | Choice | hmac-sha256 | Every delivery is signed. Saved without a signing secret, one is generated and shown to you once. |
| Retry limit | Number | ||
| Status | Choice | active, paused, disabled | |
| Exception reason | Long text | Administrators only, and only when this webhook must send to a public request bin or tunnel (webhook.site, ngrok and the like) for a supervised test: say why. Kept with the webhook and in the audit trail. |
What you can do here
Send primary
Send an event
Asks for: Event type* Payload
Set signing secret
Asks for: Signing secret
* required
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.