In this section · 4 articles

Webhook Engine settings and permissions

Every field on the destination form, the columns of the Destinations and Delivery Logs lists, the fixed delivery limits, and the permissions that control each screen and action.

Applies to
Webhook Engine 2.2 and later
Who can do this
Platform owner, Administrator
Where
Webhook Engine › Destinations
On this page

Webhook Engine has no settings panel of its own. Everything is set per destination, and a few limits are fixed.

The destination form

Webhook Engine › Destinations, then New Webhook Destinations or a row's Edit. See Add a webhook destination.

FieldWhat it doesRules and default
NameHow the destination appears in lists and the delivery log.Required. Up to 255 characters.
Endpoint URLThe address each delivery is sent to with POST.Required. A full address. Use https://.
Subscribed EventsThe events that trigger a delivery.Required, at least one.
StatusActive destinations receive deliveries. Inactive and Suspended ones receive nothing. Suspended is set for you after 20 failures in a row.Required. Active for a new destination.
Rate Limit (per minute)Deliveries are spaced to stay within this rate.Required. From 1 to 1,000. 60 for a new destination. Values above 60 behave like 60.
Custom HeadersExtra headers sent with every delivery and test, as Header and Value pairs.Header up to 255 characters, value up to 1,000. Webhook Engine's own headers win a name clash. Stored encrypted, but copied into each delivery's log entry.
Event FiltersRules a record must match for a delivery to be sent, as Field, Operator (Equals or Not equals) and Value. Every rule must match.Optional. Field and value up to 255 characters. No rules means every event is sent.
Sign the timestampOn (Timestamp signed): the signature covers the timestamp and the payload, and deliveries carry X-Laramin-Signature-Version: 2. Off (Payload only): the signature covers the payload only.On for a new destination. Destinations that existed before 2.2.0 were set to off.
The Create Webhook Destinations form, with Name, Endpoint URL, Subscribed Events, Status set to Active, Rate Limit at 60, empty Custom Headers and Event Filters, and Sign the timestamp switched on.

Custom headers and event filters are only shown on the form, not on the destination's detail page.

The Destinations list

ColumnWhat it shows
Name, Endpoint URL, Subscribed Events, Status, Rate Limit (per minute)As set on the form.
Consecutive FailuresFailed attempts in a row since the last success. At 20, the destination is suspended.
Secret RotatedWhen the signing secret was last rotated. Hidden until you add it with the columns menu.
Created At, Updated AtHidden until you add them.

Each row has a Test Console link and, in its actions menu, Edit, Delete and Rotate Secret. Opening a row shows its detail page with Identity, Delivery and Diagnostics panels.

The Delivery Logs list

Webhook Engine › Delivery Logs, newest first. See Check deliveries and send one again.

ColumnWhat it shows
Recorded OnWhen the attempt finished.
DestinationThe destination's name. A deleted destination shows as name (deleted).
Event NameThe event, such as user.created.
Response CodeThe receiver's HTTP status, or No response.
DurationHow long the attempt took, in milliseconds.
AttemptWhich attempt this was, such as 2 / 5.
StatusSuccess or Failed.

You can filter by Destination, Event Name and Status. A log entry's page adds the Endpoint URL, Payload, Request Headers, Response Headers, Response Body and Error Message.

The Delivery Logs list showing Recorded On, Destination, Event Name, Response Code, Duration, Attempt and Status columns, with one row's destination shown as Staff directory sync (deleted).

Fixed limits

These can't be changed on screen.

LimitValue
Time to wait for an answer10 seconds
Attempts per delivery5
Wait before each retry5 seconds, 15 seconds, 1 minute, 5 minutes
Failures in a row before a destination is suspended20
SuccessAny 2xx response code
SigningHMAC-SHA256, with a 32-character secret created for each destination
Delivery logKept until the destination is deleted forever. Nothing removes old entries automatically.

Permissions

In the role editor, the permissions are under Webhook Destinations and Webhook Logs.

The role editor filtered by "webhook", showing the Webhook Engine module with the Webhook Destinations and Webhook Logs groups and their List, View, Create, Edit and other permissions.
PermissionLabelAllows
feature.webhook.destination.listList DestinationOpening Webhook Engine › Destinations.
feature.webhook.destination.viewView DestinationOpening a destination's detail page.
feature.webhook.destination.createCreate DestinationAdding destinations.
feature.webhook.destination.editEdit DestinationChanging destinations, including their address, events, headers and status.
feature.webhook.destination.deleteDelete DestinationMoving destinations to the trash.
feature.webhook.destination.restoreRestore DestinationBringing destinations back from the trash.
feature.webhook.destination.removeRemove DestinationDeleting destinations forever, with their delivery logs.
feature.webhook.destination.testSend Test PayloadUsing the Test Console.
feature.webhook.destination.rotate_secretRotate Signing SecretRotate Secret.
feature.webhook.log.listList LogOpening Webhook Engine › Delivery Logs.
feature.webhook.log.viewView LogOpening a log entry, including its payload and request headers.
feature.webhook.log.redeliverRedeliver Webhook DeliveryRedeliver.
feature.webhook.log.exportExport Delivery LogsExporting the delivery log to CSV.

Careful: Edit Destination lets someone change where deliveries go, and View Log shows payloads with personal details and the custom headers that were sent. Give them only to people you'd trust with that data.

To give these permissions, see Give someone a role.