Skip to main content

Webhook Subscription - Detail

A subscription is opened from the Webhook Subscriptions list. The page opens in display mode; press Edit to change it.

alt text

The header shows the subscription's name with its URL beneath it.

The action buttons:

FieldDescription
Test PingSends a test delivery to the endpoint and reports the result — the HTTP status and how long it took, or the error.
Regenerate SecretIssues a new signing secret. Confirmation dialog pops up to approve to update the receiving endpoint with the new secret.
View EventsOpens the subscription's events.

Body​

General​

FieldDescription
NameWhat the subscription is called. Required
URLThe endpoint notified. Required.
ActiveCheck mark if deliveries are being sent.

Event Types​

Which events this endpoint is notified about. The screen says it: a group checkbox subscribes to every current and future event of that group, and All events subscribes to every event from every entity, including entities added later.

Pick an entity to choose its individual operations; the list can be filtered, and switched between All and Selected to check what a subscription actually covers.

Webhook Secret​

The secret signs every delivery, so the receiving system can prove the call came from Beas.

caution

The secret is shown in clear text only once — right after the subscription is created or the secret is regenerated. Copy it then; it is never shown again.

Regenerating invalidates the current secret immediately, and the receiving endpoint has to be updated with the new one. The screen asks for confirmation before it does.

Examples​

A subscription that receives more than expected. A group checkbox is a standing subscription to that group, future events included — which is usually what you want for a partner integration and rarely what you want for a narrow one. Use Selected to read back exactly what a subscription covers before blaming the sender.

An endpoint that rejects every delivery. Test Ping separates "Beas is not sending" from "the endpoint is refusing": it reports the HTTP status and the round trip. A ping that succeeds while real events fail points at the signature — usually a secret that was regenerated here and never updated at the other end.