> For the complete documentation index, see [llms.txt](https://orimon.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://orimon.gitbook.io/docs/integrations/webhook.md).

# Webhook

This is a step-by-step guide on how to use Webhook Integration to sync all Leads on your private servers.

1. Log in to [Dashboard](https://orimon.ai/login) using your Google account/manual signup
2. Once logged in, you should see an icon for your bot. Click on it to go to the bot's overview page.

<figure><img src="https://55912965-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxUW02x9klXneNc1Bxtt6%2Fuploads%2FFggcGJj0csqUzA1brMeF%2FScreenshot%20from%202024-01-12%2012-41-48.png?alt=media&amp;token=14feb440-eb5a-4f7c-b6bc-521d473732fc" alt=""><figcaption></figcaption></figure>

3. On the overview page, you will see several tabs. Click on "Settings" -> "LeadFlow Integrations".

<figure><img src="https://55912965-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxUW02x9klXneNc1Bxtt6%2Fuploads%2Fuwh8ymQ9dB5jdBAapLsu%2FScreenshot%20from%202024-01-12%2013-55-38.png?alt=media&amp;token=e0c3c589-cd67-47dc-b216-a49df1c2b51e" alt=""><figcaption></figcaption></figure>

<figure><img src="https://55912965-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxUW02x9klXneNc1Bxtt6%2Fuploads%2F2uGvx3Ct0SJ48ZxM0fCZ%2FScreenshot%20from%202024-01-29%2011-56-27.png?alt=media&amp;token=f2260326-593b-4d04-a9fb-5be49d8d86ea" alt=""><figcaption></figcaption></figure>

Click on this option to navigate to a integrations page and click on "**Webhook**". You will see a page shown below.&#x20;

<figure><img src="https://55912965-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxUW02x9klXneNc1Bxtt6%2Fuploads%2FnhNgsA05xwP5NfIfxvEr%2FScreenshot%20from%202024-01-29%2011-59-15.png?alt=media&amp;token=edbbd99d-bb0c-45cd-9d9f-8974ded0dc68" alt=""><figcaption></figcaption></figure>

In the "**Webhook URL**" input paste the endpoint of the server where you receive and process your Leads, like the example shown below.&#x20;

<figure><img src="https://55912965-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxUW02x9klXneNc1Bxtt6%2Fuploads%2FXVd3sk5P3JhLMVBYFFmK%2FScreenshot%20from%202024-01-29%2012-02-06.png?alt=media&amp;token=13edf3da-9b25-4f99-949e-0e02ffd9de94" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
*<mark style="color:purple;">**Before proceeding please note**</mark> : The server where you will receive the data **must** be configured to accept* **`POST`** *requests.*

*In order to verify this, when you provide a server endpoint, Orimon will first send a dummy* **`POST`** *request, which in **response must return a status code of&#x20;**<mark style="color:green;">**200**</mark>.*&#x20;

*<mark style="color:red;">Failing</mark> this, <mark style="color:red;">no Leads data</mark> will be sent nor will the <mark style="color:red;">server endpoint be saved</mark> for follow up data syncing.*

*Once this protocol is successfully carried out, the follow up* **`POST`** *request will contain all Leads collected via your bot and be sent in the* **`request.body`** *.*
{% endhint %}

Now, click on the "**Submit**" button,

If the integration was successful you see a screen like the one shown below, with your server URL in the input box.

<figure><img src="https://55912965-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxUW02x9klXneNc1Bxtt6%2Fuploads%2F5iqljfVacTr54SVKN8Gm%2FScreenshot%20from%202023-07-04%2015-37-10.png?alt=media&amp;token=127c6814-f8c2-49a8-ba8b-43909e19625a" alt=""><figcaption><p>Integration Settings</p></figcaption></figure>

And you will also receive all Leads in a **`POST`** request at your provided server. Like so :  &#x20;

<figure><img src="https://55912965-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxUW02x9klXneNc1Bxtt6%2Fuploads%2FAk100uBe3LeudqmGsVvJ%2FScreenshot%20from%202023-07-04%2015-40-08.png?alt=media&amp;token=29af5b86-5716-449b-87e9-f6a5098d48c5" alt=""><figcaption></figcaption></figure>

*If the integration, for any reason, is unsuccessful you will remain at the first page of the Webhook service and receive an error message informing you what went wrong.*

Now in the image above labelled "Integration Settings" \
The first among these is a button "**Send Lead Form**", this is simply there to re-send all the stored Leads data at that point, if for any reason data is lost.

You will also see a switch "**Active**" which will temporarily disable Leads data syncing, for as long as you don't re-activate it. You can do this, if for any reason (like maintenance), your servers are temporarily down

The Last among these options is a "**Delete**" button, which will remove this integration altogther.

That's all! Now you will have your Leads data directly delivered to you, for you to use them as you see fit!
