> ## Documentation Index
> Fetch the complete documentation index at: https://docs.uservox.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# How to add Webhook to a process

> Webhooks allow you to receive real-time updates about lead activity and process outcomes in your own system. By adding a webhook (called Lead Update Callback), you can push lead status, call activity, and disposition updates to your backend automatically.
This guide explains how to add and configure a webhook for a process.

## Step-by-Step: Add a Webhook to a Process

### 1. Open the Process

* Go to **Processes** from the main dashboard.

<img src="https://mintcdn.com/uservox/PwQXdHb0nZGU30ov/images/Screenshot2026-02-02at11.42.35AM.png?fit=max&auto=format&n=PwQXdHb0nZGU30ov&q=85&s=4a2e86ba0572b911a578c3fb6411960e" alt="Screenshot2026 02 02at11 42 35AM" width="2658" height="1780" data-path="images/Screenshot2026-02-02at11.42.35AM.png" />

* Select the process where you want to add the webhook (e.g., *OutReach Plan (hinglish)*).

### 2. Go to Advanced Settings

* Inside the process details page, scroll down to **Advanced Settings**.

<img src="https://mintcdn.com/uservox/PwQXdHb0nZGU30ov/images/Screenshot2026-02-02at11.42.50AM.png?fit=max&auto=format&n=PwQXdHb0nZGU30ov&q=85&s=6f5a8d60bd3b453bd561828e2264d55c" alt="Screenshot2026 02 02at11 42 50AM" width="2660" height="1704" data-path="images/Screenshot2026-02-02at11.42.50AM.png" />

* Expand the section if it is collapsed.
* You will see **Lead Update Callbacks**.

### 3. Add a New Callback

* Click on **+ Add Callback**.

* A new block (e.g., *Callback 1*) will appear.

<img src="https://mintcdn.com/uservox/PwQXdHb0nZGU30ov/images/Screenshot2026-02-02at11.43.04AM.png?fit=max&auto=format&n=PwQXdHb0nZGU30ov&q=85&s=c07688c67cb2109fcad2b360b3dffdf8" alt="Screenshot2026 02 02at11 43 04AM" width="1262" height="1298" data-path="images/Screenshot2026-02-02at11.43.04AM.png" />

### 4. Configure the Webhook

#### a. Lead Update URL

* Enter your webhook endpoint URL.

Example:

```
https://yourdomain.com/api/lead-callback
```

This endpoint will receive POST requests when lead updates occur.

<img src="https://mintcdn.com/uservox/PwQXdHb0nZGU30ov/images/Screenshot2026-02-02at11.43.16AM-1.png?fit=max&auto=format&n=PwQXdHb0nZGU30ov&q=85&s=d8d4257c5651325c27e8a40dd69582d0" alt="Screenshot2026 02 02at11 43 16AM 1" width="1258" height="1496" data-path="images/Screenshot2026-02-02at11.43.16AM-1.png" />

#### b. Payload Format

Choose how much data you want to receive:

* **Activity Update – Only send updates related to latest activity** (recommended)

This sends updates only when something meaningful happens (call completed, disposition updated, etc.).

#### c. Callback Requirements (Optional)

* Enable **Requires source to be whitelisted** if your server only accepts requests from approved IPs.

#### d. Authentication (Optional)

If your endpoint requires authentication, configure one of the following:

* **Bearer Token**
  * Add a token that will be sent in the `Authorization` header.

OR

* **Custom Auth Header**
  * **Auth Key**: e.g. `X-API-Key`
  * **Auth Value**: your API key value

These headers will be included with every webhook request.

### 5. Save and Verify

* Make sure there are no validation errors (Advanced Settings should show **OK**, not **Errors**).
* Save the process if required.

Once saved, the webhook becomes active immediately.

## When Will the Webhook Fire?

The webhook is triggered when:

* A call attempt is completed
* Lead status changes (Interested, Not Interested, No Answer, etc.)
* Final disposition is marked
* The latest activity in the process changes

## Common Errors & Tips

* **Advanced Settings shows “Errors”**
  * Check that the Lead Update URL is valid (HTTPS recommended)
  * Ensure required auth fields are correctly filled
* **No callbacks received**
  * Confirm your endpoint accepts `POST` requests
  * Verify authentication headers
  * Check server logs for rejected requests

## Best Practices

* Use a dedicated endpoint for webhooks
* Log incoming payloads for debugging
* Respond with HTTP `200 OK` quickly to avoid retries
* Secure the endpoint using auth headers

***

You’re now set up to receive real-time lead updates from your process 🚀
