Overview

Webhooks allow you to receive real-time notifications when certain events occur in our system. Instead of repeatedly polling our API, webhooks push data to your application as events happen, making your integration more efficient and responsive.

How Webhooks Work

Webhooks work on a per-environment basis. There are 3 different environments: development, staging, and production.

When an event occurs, we'll send an HTTP POST request to your configured webhook endpoint with details about the event.

Setting Up Webhooks

1. Update your API key environment: Go to your API keys dashboard and ensure your API keys are assigned to the correct environment
2. Create a webhook: Visit https://app.usercheck.com/webhooks
3. Click "Add webhook"
4. Choose your environment: Select which environment you want to use the webhook on
5. Enter your endpoint URL: Provide the URL where you want to receive webhook notifications
6. Select events: Choose which events you want to be notified about
7. Click "Create"

Testing your endpoint

Once you've created your webhook, you can test that it's working correctly by using the "Send test webhook" option in your webhook settings. This will send a sample payload to your endpoint so you can verify that your webhook is receiving notifications properly.