Skip to main content
POST
/
v0
/
validate-webhook
Validate an incoming webhook request
curl --request POST \
  --url https://api.avidoai.com/v0/validate-webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '{
  "signature": "abc123signature",
  "timestamp": 1687802842609,
  "body": {
    "prompt": "I lost my card, please block it.",
    "testId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "customerId": "1",
      "priority": "high"
    }
  }
}'
{
  "valid": true
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Raw JSON payload sent by an external webhook, including signature and timestamp. HMAC verification is used for security.

​
signature
string
required

HMAC signature for the request body.

Example:

"abc123signature"

​
timestamp
integer
required

Timestamp (in milliseconds) for the request.

Example:

1687802842609

​
body
object
required

The payload received from Avido. Use this in signature verification. Payload sent to the configured webhook whenever a task test is triggered.

Response

Webhook is valid

Response object indicating whether the webhook was valid.

​
valid
boolean
required

Indicates if the webhook payload was successfully validated.

Example:

true