> For the complete documentation index, see [llms.txt](https://guides.pave.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guides.pave.ai/branch-dashboard/user-feature-walkthrough/developer-tools/webhooks.md).

# Webhooks

Create webhooks and get notified for supported events for all sessions relating to your API-Key through a JSON payload.

### Setting Up a Webhook

**Step 1:** Add a new Webhook on your PAVE dashboard as shown below

<figure><img src="https://1101422075-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkOe4CeRywX7c1q79rw84%2Fuploads%2Fc83mzIpaZyNqEzhgkjeh%2FUntitledsdsf%20(1).png?alt=media&amp;token=6ef34414-af2a-48bc-b368-2a146c5c48bf" alt=""><figcaption><p>Add a Webhook</p></figcaption></figure>

**Step 2:** Configure the settings as per your use-case and click 'Create'

<figure><img src="https://1101422075-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkOe4CeRywX7c1q79rw84%2Fuploads%2F56Mq1AuGDc4q0PUsLDT2%2FScreenshot%202023-12-20%20114555.png?alt=media&amp;token=f232613a-4bd6-4bd5-b39e-230132b667ff" alt=""><figcaption><p>Configure a Webhook</p></figcaption></figure>

| Parameter       | Description                                                                                                                     |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| API Keys        | Select the API Key associated with this webhook                                                                                 |
| Callback Events | Select the Callback Event you would like to set up. Read more about Callback Events [here](broken://pages/-Mar22soarTMZDpJSvp5) |
| Endpoint        | Add the Endpoint URL where you would like to receive the JSON associated with the Callback Event                                |
| Method          | Based on your selected Callback, the API operations such as GET, POST, PUT get selected automatically. No action for the user   |

{% hint style="info" %}
You can only set up one webhook event per API Key per Callback Event.&#x20;
{% endhint %}

#### Manually Sending a Webhook

Webhooks once set, can be sent manually using the PAVE dashboard as well. This is required in cases where the webhook did not send or saw an error.&#x20;

Please see the screenshot below on how to send a webhook manually:

<figure><img src="https://1101422075-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkOe4CeRywX7c1q79rw84%2Fuploads%2FV4sYZroLdkROARqPVkPP%2Fimage.png?alt=media&amp;token=532a4c07-439e-45d0-a32f-9e61febc10ff" alt=""><figcaption><p>Manually Send a Webhook</p></figcaption></figure>