Send a test webhook

Send a sample event to a configured webhook endpoint. Useful for verifying signature handling.

POST /v1/webhooks/test

Send a test webhook

cURL

curl --request POST \
  --url https://api.vly.ai/v1/webhooks/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpointId": "<string>"
}
'

Sends a synthetic event to the registered webhook URL. The payload mirrors a real event; the signature is computed with your real signing secret so handlers can be verified end-to-end.

Available test events: project.created, deployment.succeeded, deployment.failed, agent.completed.

For full webhook documentation, see the Webhooks recipe.

Authorizations

Authorization · string · header · required

Workspace-scoped API key. Generate from Workspace settings → API keys.

Body

application/json

endpointId · string · required

event · enum<string> · required

Available options: project.created, deployment.succeeded, deployment.failed, agent.completed

Response

204

No content — webhook dispatched.