Configuration

Enabling Webhooks

Webhooks are disabled by default and must be enabled individually for each application.

To enable webhooks:

1. In the Wristband Dashboard, navigate to the application for which you want to enable webhooks.
2. Select Webhooks from the left navigation menu.
3. Turn on the Enable Webhooks toggle.

Once enabled, Wristband begins generating webhook events for the application. To receive these events, you must configure at least one webhook endpoint in the Svix Consumer App Portal.

Configuring Webhook Endpoints

Webhook endpoints define where Wristband sends event notifications. You can configure multiple endpoints and choose which event types each endpoint receives.

To create a webhook endpoint:

1. From the Webhooks page in the Wristband Dashboard, click Open Portal to launch the Svix Consumer App Portal in a new browser tab.

2. In the Svix Consumer App Portal, select Endpoints from the left navigation menu, then click Add Endpoint.

3. Enter the URL where you want to receive webhook events and select the event types you want the endpoint to receive.
4. Click Create to save the endpoint.

Once the endpoint is created, Svix begins delivering matching webhook events to the configured URL using HTTP POST requests.

Testing with Svix Play

If you don't have an endpoint URL available yet, you can use Svix Play to generate a temporary testing URL and inspect incoming webhook events without building your own webhook receiver.

To configure a test endpoint:

1. When creating a webhook endpoint, click the with Svix Play link below the endpoint URL field to generate a Svix Play URL.
2. Select the event types you want to receive, then click Create.

3. Once the endpoint is created, click View in Svix Play to open the Svix Play interface, where you can inspect webhook events received by the endpoint.

Sending Test Events

You can send example webhook events through the Svix Consumer App Portal to verify that your endpoint is configured correctly and can receive webhook requests.

To send a test event:

1. In the Svix Consumer App Portal, navigate to Endpoints.
2. Select the endpoint you want to test.
3. Open the Testing tab.
4. Select the event type you want to simulate.
5. Click Send Example to send a test event to the selected endpoint.

Enabling Webhook Alerts

We recommend enabling webhook alerts so you can be notified when delivery issues occur. Svix can send email notifications when webhook deliveries fail or when an endpoint is disabled due to repeated delivery failures.

To configure webhook alerts:

1. In the Svix Consumer App Portal, select Alerting from the left navigation menu.
2. Enable email notifications.
3. Enter the email addresses that should receive webhook alerts.
4. Click Save to apply your changes.