Webhooks

On any of Mindee's API that support asynchronous requests, you will have the ability to create one or several webhooks to retrieve your predictions. (See Asynchronous Prediction)

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

Note: you can define more than one active webhook for a single API, for example for your development and production environments.

Create a new 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.

Simply click on 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:

Signing Secret

For every new webhook created, we will generate a custom Signing secretthat can be used to ensure the integrity and authenticity of the data sent to your endpoint. See how to validate the HMAC signature integrity.

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.

Note: this key being a secret, it is not recommended to store it anywhere in plain-text, we recommend using environment variables.

Edit your Webhooks

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

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

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

PreviousSettings NextMy Account

Last updated 2 days ago

Was this helpful?