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

# Webhooks

> Learn how to set up webhooks and use them to forward OpenLineage events.

## Configure a Webhook

### 1. Go to your team settings

Settings ➞ [Webhooks](https://oleander.dev/app/settings/webhooks).

### 2. Select Create Webhook

Webhooks ➞ Create Webhook.

### 3. Add Webhook

Enter your webhook URL.

<img className="block dark:hidden rounded-md" src="https://mintcdn.com/oleander/Pkx46010SxSD-P6X/images/create-webhook-light.png?fit=max&auto=format&n=Pkx46010SxSD-P6X&q=85&s=8a307081ffa00f35ad5c76c02a79af5d" alt="Hero Light" width="1992" height="972" data-path="images/create-webhook-light.png" />

<img className="hidden dark:block rounded-md" src="https://mintcdn.com/oleander/Pkx46010SxSD-P6X/images/create-webhook-dark.png?fit=max&auto=format&n=Pkx46010SxSD-P6X&q=85&s=ca915a88d580da1852c73a41c02c557e" alt="Dark Hero" width="1992" height="980" data-path="images/create-webhook-dark.png" />

Once you have configured your webhook, click the `Submit` button.

The Add Webhook dialog will display a secret key, which won't be shown again.
You should secure your webhooks by comparing the `X-Oleander-Signature`.

<img className="block dark:hidden rounded-md" src="https://mintcdn.com/oleander/Pkx46010SxSD-P6X/images/webhook-sig-light.png?fit=max&auto=format&n=Pkx46010SxSD-P6X&q=85&s=dd5dcbf21bce88371c032228d7cdd2cb" alt="Hero Light" width="2076" height="1272" data-path="images/webhook-sig-light.png" />

<img className="hidden dark:block rounded-md" src="https://mintcdn.com/oleander/Pkx46010SxSD-P6X/images/webhook-sig-dark.png?fit=max&auto=format&n=Pkx46010SxSD-P6X&q=85&s=817539d25dd5ce778cd50a4a42f7f4bd" alt="Dark Hero" width="1992" height="1196" data-path="images/webhook-sig-dark.png" />

Once complete, click `Done`. Note, only OpenLineage events for jobs you are watching will be forwarded.
To view watched jobs, go to the [Watcher](https://oleander.dev/app/settings/watchers) section.

To view all your new and existing webhooks, go to the Webhooks section of your team's setting.

### OpenLineage Events

The webhook URL receives an HTTP `POST` request with a `JSON` payload for each event.
All events will be formated following the OpenLineage [specification](https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json).