Skip to main content
POST
/
webhooks
/
test
Verify webhook connectivity
curl --request POST \
  --url https://{publicHost}/webhooks/test \
  --header 'Authorization: Basic <encoded-value>'
{
  "url": "https://api.demo-bank.com/webhooks/blips",
  "responseStatus": 200,
  "responseBody": "ok"
}

Authorizations

Authorization
string
header
required

Integration-key Basic Auth (clientId:clientSecret) as documented in docs/public/AUTHENTICATION.md.

Response

Webhook connectivity verification result.

url
string
required

Configured webhook endpoint that was tested.

responseStatus
integer
required

HTTP status returned by the tested webhook endpoint.

responseBody
string | null
required

Bounded preview of the response body returned by the tested endpoint.