Outbound Webhooks is an event-driven integration mechanism in Staffbase that sends HTTP POST notifications to an external HTTPS endpoint whenever a specific event occurs within the platform.
Configure an Outbound Webhook
You can create a webhook for available events for which you want to get notifications in your external system.
Prerequisites
- You are an administrator in your Staffbase platform.
- An HTTPS endpoint on your external system that is able to receive HTTP POST requests. See Receiving endpoint requirements for more details.
-
In the Studio, navigate to Settings > Extensions > Webhooks.
The Webhooks page opens. -
Click Create Webhook.
The Create Webhook page opens. -
In Webhook Event, select one or more event types you want to subscribe to.
-
In Target URL, provide the HTTPS endpoint on your server that receives the notifications.
-
Under Signing Secret, select one of the following options for signing secrets:
- Generate a Signing Secret Automatically
- Enter Your Own Signing Secret
-
If you selected Enter Your Own Signing Secret, enter a signing secret in the field provided.
-
Click Create.
You have created a webhook. Staffbase sends a notification to the configured endpoint each time the selected event occurs. You can edit, pause, resume, or delete it at any time.
Check the delivery history of a webhook
You can view a webhook’s delivery history, including its status and delivery details.
-
In the Studio, navigate to Settings > Extensions > Webhooks.
-
Click All deliveries.
-
Find the webhook delivery you want to review.
-
Click the Details arrow to view the delivery details.