> For the complete documentation index, see [llms.txt](https://help.pickyassist.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.pickyassist.com/api-documentation-v2/webhook/configuring-webhook-url.md).

# Configuring Webhook URL

Setting Up Your Webhook to Receiving Incoming Messages

You need to configure the Webhook against each project from the web console, to configure webhook Login Into your Picky Assist Web Console -> `Select Project -> Settings -> Developers ->` [`Webhooks`](https://pickyassist.com/app/settings/developers/webhook)&#x20;

<figure><img src="https://3382165395-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LlJChpzcxtwOYGcBd1q%2Fuploads%2FeOoIu32KH1JzOazEwR4A%2Fimage.png?alt=media&amp;token=c6b30273-0c59-4bea-960a-724c5b57e18d" alt=""><figcaption></figcaption></figure>

## Passing Custom Variable

If you would like to pass any additional variables to be pushed then please configure them as `yourfilename.aspx?variable1=picky-newyork&variable2=newclient\`

<figure><img src="https://3382165395-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LlJChpzcxtwOYGcBd1q%2Fuploads%2FF7ym6L4gYk7ZMikVQzUn%2Fimage.png?alt=media&amp;token=7bf0c260-db7d-4fa2-8b32-e4f5cbb99de7" alt=""><figcaption></figcaption></figure>

## **Enabling Retry**

You can optionally enable the retry feature so that in case if your server or network has any issues we will re-push the webhook again.

<figure><img src="https://3382165395-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LlJChpzcxtwOYGcBd1q%2Fuploads%2FzeQxndeZlLpkfEaoxN8w%2Fimage.png?alt=media&amp;token=d08e629b-add5-40d0-ad03-27e822c34768" alt=""><figcaption></figcaption></figure>

### When the retry will enable?

If your webserver/application does not return **200 response** within 180 seconds then the webhook calls from our server will enter into retry mode and trigger as per the below cycle ;

1 Minute = 1st retry\
15 Minutes = 2nd retry\
2 Hours = 3rd retry\
6 Hours = 4th retry

{% hint style="warning" %}
Even after 4th retry if we don't get the 200 response from your webhook then the retry will retire forever.&#x20;
{% endhint %}

{% hint style="info" %}
Make sure to click the **Save** button to apply the changes whenever any modifications are made in the webhook settings, including enabling or disabling retry options.
{% endhint %}

## **Testing Webhook**

After configuring the Webhook you can test the webhook by clicking **“Test”** dummy data will post to your web server and you need to give JSON response if you wish to give an instant reply back to the user.

<figure><img src="https://3382165395-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LlJChpzcxtwOYGcBd1q%2Fuploads%2FjhwLeLm8hcbKGNU8n30j%2Fimage.png?alt=media&amp;token=2284be36-87f8-4ef6-bb77-c318f133130e" alt=""><figcaption></figcaption></figure>

## **Success Response**

![Webhook Sucess Message](https://3382165395-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LlJChpzcxtwOYGcBd1q%2F-LlJFrLuct-YucAsyB3r%2F-LlJLbE24oarV2kT_BvC%2Fwebhook-sucess-message.png?alt=media\&token=0e22374a-217c-4135-93ad-2fc3cdadd242)

{% hint style="danger" %}
Please note if your response is not in JSON then you will get the following error as response.
{% endhint %}

![Webhook Response Error ](https://3382165395-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LlJChpzcxtwOYGcBd1q%2F-LlJFrLuct-YucAsyB3r%2F-LlJLicrQwKi1eyuxTId%2Fwebhook-test-response.png?alt=media\&token=8114e5b4-6d70-4005-909a-78b70a718901)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.pickyassist.com/api-documentation-v2/webhook/configuring-webhook-url.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
