POST
/
v0
/
validate-webhook
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": {
    "eventType": "userCreated",
    "user": {
      "id": "user_123",
      "email": "test@example.com"
    }
  }
}'
{
  "valid": true
}

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique application ID. Get this from the Connections page in Avido.

Body

application/json

The webhook request body to validate

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

200
application/json
Webhook is valid

Response object indicating whether the webhook was valid.

valid
boolean
required

Indicates if the webhook payload was successfully validated.

Example:

true