Browse documentation
Reference
For AI agents
Coding agents and automation should read the machine-readable summary instead of scraping this page. It lists base URLs, authentication headers, route paths, and error codes in plain text.
Machine-readable docs: /llms.txt · /llms-full.txt · /docs/signatures.md
Recommended flow
- Fetch /llms.txt, then read the REST API section below.
- Create a dedicated API key per agent in Settings → API keys, and load it from an environment variable.
- Create an endpoint, queue a test event, then poll deliveries until they succeed or fail.
Create an endpoint and queue a test event
curl -X POST "https://api.hooks.events/v1/endpoints" \
-H "Authorization: Bearer $HOOKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "agent-test",
"provider": "generic",
"verificationMode": "hmac",
"destinations": [{ "url": "https://example.com/hooks" }]
}'
# Queue a test event, then poll deliveries
curl -X POST "https://api.hooks.events/v1/endpoints/$ENDPOINT_ID/test-events" \
-H "Authorization: Bearer $HOOKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"eventType":"agent.check"}'Never print API keys or signing secrets in logs, commits, or chat. Prefer test events over replaying production events, and respect 429 responses and the Retry-After header.
Was this page helpful?
Tell us if something was missing or unclear.
Ready to try it?Create a free workspace and send your first event.