Test webhook configuration for an application

curl --request POST \
  --url https://api.avidoai.com/v0/webhook/test \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'

{
  "success": true,
  "statusCode": 200
}

POST

webhook

test

Test webhook configuration for an application

curl --request POST \
  --url https://api.avidoai.com/v0/webhook/test \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'

{
  "success": true,
  "statusCode": 200
}

x-api-key

string

header

required

Your unique Avido API key

x-application-id

string

header

required

Your unique Avido Application ID

Test webhook request completed

Response indicating whether the webhook test was successful

success

boolean

required

Whether the webhook test was successful

Example:

true

statusCode

integer

HTTP status code returned by the webhook endpoint

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

200

error

string

Error message if the webhook test failed

Example:

"Webhook failed with status=500"