When you register a webhook and activate it, Prelude will send a verification challenge request to the webhook endpoint.

This is a GET request to the webhook endpoint. You need to return a 200 OK response with the verification challenge response, that you set in the verification_token parameter when you registered the webhook.

The webhook will be activated only after the verification challenge request is successful. If the verification challenge request fails, the GET /v2/session/apps/{appID}/webhooks/{webhookID}/activate will fail with a 400 Bad Request error and the webhook will not be activated.

Once the webhook is activated, you will start directly receiving events from Prelude.

Verification challenge response

The verification challenge response is a JSON object with the following properties:

verification_token
string
required

The verification token you set when you registered the webhook.