Webhooks

Reveal or rotate your webhook signing secret

Changed on

Return your signing secret, in full, in this response only.

Every delivery is signed from your first event. If you have not read your secret yet, this call returns it without changing it, so you can verify deliveries you have already received. If you have, this call creates a new secret; the previous one keeps signing for 24 hours, and during that time each delivery carries two v1 signatures so you can switch over without dropping events.

post/v2/webhooks/secret

Request

  • Base URL
    https://api.imentiv.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Response

Successful Response

secretstring required

The signing secret, whsec_.... Store it now; it is not shown again.

secret_last4string required
rotatedboolean required

True if this call replaced a secret you had already read. The previous secret keeps signing deliveries alongside the new one for 24 hours. False if it returned the secret created for your account, which is not rotated so that you can verify deliveries already sent.

previous_secret_expires_atstring date-time nullable

Changes