Creating a webhook is a two-step process. You'll first need to set up how you want your webhook to behave and what events should it listen to. After that, you'll set up your server to receive and manage the payload.
Setting up a Webhook
To set up a webhook, go to the Webhooks page of your Partner Portal. From there, click the New button.
Alternatively, you can choose to build and manage a webhook through the Webhooks API (docs coming soon).
Webhooks require a few configuration options before you can make use of them. We'll go through each of these settings below.
The payload URL is the URL of the server that will receive the webhook
Setting a webhook secret allows you to ensure that
POST requests sent to the
payload URL are from Bold Penguin. When you set a secret, you'll receive the
X-Signature header in the webhook POST request.
If your server requires the request to contain a header for purposes like
authentication, you can configure that here. Use the format
By default, webhook deliveries are "Inactive." You can choose to enable the delivery of webhook payloads by selecting "Active."
Events are at the core of webhooks. These webhooks fire whenever a certain event occurs, which your server's payload URL intercepts and acts upon.
A full list of webhook events, and when they execute, can be found in the webhooks API reference.
When you're finished, click Add webhook.