Skip to main content

​
Why webhook‑triggered tests?

Part of Avido’s secret sauce is that you can kick off a test without touching your code.
Instead of waiting for CI or redeploys, Avido sends an HTTP POST to an endpoint that you control.
BenefitWhat it unlocks
Continuous coverageRun tests on prod/staging as often as you like and automated.
SME‑friendlyNon‑developers trigger & tweak tasks from the Avido UI.

​
How it works

  1. A test is triggered in the dashboard or automatically.
  2. Avido POSTs to your configured endpoint.
  3. Validate the signature + timestamp with our API/SDK.
  4. Run your LLM flow using prompt from the payload.
  5. Emit a trace that includes testId to connect results in Avido.
  6. Return 200 OK – any other status tells Avido the test failed.
Validating a webhook with the API requires both x-api-key and x-application-id headers. Use the application ID that issued the API key.

​
Payload example

When Avido triggers your webhook endpoint, it sends:
Webhook payload
{
  "prompt": "Write a concise onboarding email for new users.",
  "testId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "customerId": "1",
    "priority": "high"
  }
}
Headers:
HeaderPurpose
x-avido-signatureHMAC signature of the payload
x-avido-timestampUnix ms timestamp (in milliseconds) the request was signed
Notes:
  • testId is optional and only included when running actual tests
  • metadata is optional and only included when available from the originating task

​
Verification flow

If validation fails, respond 401 (or other 4xx/5xx). Avido marks the test as failed.

​
Code examples

curl --request POST   --url https://api.avidoai.com/v0/validate-webhook   --header 'Content-Type: application/json'   --header 'x-application-id: <application-id>'   --header 'x-api-key: <api-key>'   --data '{
  "signature": "abc123signature",
  "timestamp": 1687802842609,
  "body": {
    "prompt": "Write a concise onboarding email for new users.",
    "testId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "customerId": "1",
      "priority": "high"
    }
  }
}'

​
Next steps

  • Send us Trace events.
  • Schedule or manually tasks from Tasks in the dashboard.
  • Invite teammates so they can craft evals and eyeball results directly in Avido.