> For the complete documentation index, see [llms.txt](https://docs.mindee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mindee.com/v1/workflows/workflows-ui-tour/webhooks-workflows.md).

# Webhooks

## Overview

<figure><img src="/files/Ik3wRXW1BEAheKu92fGj" alt=""><figcaption></figcaption></figure>

Workflows are built on an asynchronous endpoint. To retrieve your Predictions and validated data you will need to setup webhooks.

To do so, click on the **Webhooks** item from your workflow menu. On this interface you'll be able to create, edit or delete your webhooks configuration.

{% hint style="success" %}
You can define more than one active webhook for a single workflow, for example for your development and production environments.
{% endhint %}

## Create a webhook

To create a new webhook, click on the `Create a new webhook` button. A form will show, with only two fields to fill:

* the product version you want your webhook to listen for
* the endpoint URL where the predictions will be sent. *Although we accept any valid URL, we greatly recommend using an HTTPS URL here, to ensure your data security.*

<figure><img src="/files/PsBoGoaKr9ezgniTz7AI" alt=""><figcaption></figcaption></figure>

* Hit the **Create new webhook** button in order to finalize your webhook creation. Once this is done, a new line will appear on your webhook list:

<figure><img src="/files/OfUoXues4zYo72diioMV" alt=""><figcaption></figcaption></figure>

### Signing Secret

For every new webhook created, we will generate a custom `Signing secret`that can be used to ensure the integrity and authenticity of the data sent to your endpoint. See [how to validate the Hmac signature integrity](/v1/apis-overview/endpoints/prediction-asynchronous.md#validate-the-hmac-signature-optional).

You can, at any point in time, visualize your signing secret by clicking on the crossed eye icon. You can also click the clipboard icon in order to copy the secret to add it to your code easily

{% hint style="warning" %}
This key being a secret, it is not recommended to store it anywhere in plain-text, we recommend using environment variables.
{% endhint %}

### Edit your Webhooks

To Edit an existing webhook, click on the **`...`** button at the very end of your webhook item.

<figure><img src="/files/8NCEFzD7wKCP3MqHYHZe" alt=""><figcaption></figcaption></figure>

A floating menu will appear giving you the possibility to:

* Edit a webhook by changing the provided URL.
* Delete an existing webhook
* Regenerate your signing secret

When validated, any of those actions will be immediately effective.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.mindee.com/v1/workflows/workflows-ui-tour/webhooks-workflows.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.