Confirm a webhook

POST 
/api/v8/partner/settings/webhooks/confirm

Confirm a pending webhook after receiving Veryfi's verification POST.

Use the exact webhook URL you added and the data.secret value from the verification payload. When the secret matches an unexpired pending webhook, Veryfi marks the webhook as confirmed and uses it for notifications. Pending verification secrets expire after 1 day.

Request

application/json

Body

url urirequired

Possible values: non-empty and <= 2083 characters

The same webhook URL that received Veryfi's verification POST.

secret stringrequired

Possible values: non-empty

The data.secret value from Veryfi's webhook verification payload.

Responses

204

Webhook confirmed. Veryfi will use it for future notifications.

400

Secret is missing, expired, or does not match the pending webhook URL.

application/json

Schema

Schema

any

invalid_secret

Invalid secret

{
  "status": "fail",
  "error": "Secret is not valid for this webhook url"
}

malformed_parameters

Malformed confirmation payload

{
  "status": "fail",
  "error": "Malformed parameters"
}

Loading...