Webhooks

Verify a webhook endpoint

Trigger ownership verification of the endpoint URL.

Improvado sends a GET request to the endpoint URL with the headers:

  • X-Improvado-Verify-Token — the endpoint's signing secret
  • X-Improvado-Challenge — a one-time random token

The receiver must respond with HTTP 200 and the value of X-Improvado-Challenge as the response body. On success, the endpoint transitions to active. On failure (non-200 status, mismatching body, or connection error), the endpoint remains unverified and a 400 is returned.

post/api/v3/webhook_endpoints/{id}/verify/

Request

Path parameters

idinteger required

Webhook endpoint ID

Response

Endpoint verified successfully (status is now active)

idinteger
urlstring uri
secretstring

64-character hex signing secret

status'unverified' | 'active'
consecutive_failuresinteger
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.