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>' \
  --data '{
  "signature": "abc123signature",
  "timestamp": 1687802842609,
  "body": {
    "eventType": "userCreated",
    "user": {
      "id": "user_123",
      "email": "test@example.com"
    }
  }
}'
{
  "valid": true
}

Authorizations

x-api-key
string
header
required

Your unique Avido API key

Body

application/json

The webhook request body to validate 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
number
required

Timestamp (in milliseconds) for the request.

Example:

1687802842609

body
object
required

The actual payload being sent by the external webhook.

Example:
{
"eventType": "userCreated",
"user": {
"id": "user_123",
"email": "test@example.com"
}
}

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