IMimentiv
Webhooks

Choose your webhook payload format

Changed on

Set the payload format for events created from now on.

legacy is the format sent before payload versions existed and is only available to accounts that already receive it. Events already created keep the format they were created with.

put/v2/webhooks/settings

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

Request body

payload_version'legacy' | 'v1' required

The payload format to use for events created from now on. legacy can only be kept, not chosen: it is available to accounts that already receive it.

Response

Successful Response

has_secretboolean required

Whether a signing secret exists for your account.

secret_last4string nullable

The last four characters of the current secret, to tell secrets apart.

secret_revealedboolean required

False until you have read your secret with POST /v2/webhooks/secret. Deliveries are signed from your first event, so read it before you start verifying.

created_atstring date-time nullable

When the current secret was created.

previous_secret_expires_atstring date-time nullable

After a rotation, until when the previous secret still signs deliveries. While this is in the future each delivery carries two v1 signatures.

payload_version'legacy' | 'v1' required

The payload format your webhooks use. legacy is the format sent before payload versions existed (UPPERCASE status values, free-text error). v1 is the documented format.

Changes