API reference
Send a test event
POST /v1/webhooks/{receiver_id}/test
One signed webhook.test event to this receiver, at once, through the same path every delivery takes — and whether it arrived. Needs webhooks:write.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
receiver_id |
path | string (uuid) | Yes |
Answer
200 with WebhookTest.
Errors
Every error is a problem document with a stable code.
| Status | When |
|---|---|
401 |
The key is missing, mistyped, unknown, revoked or expired. |
403 |
The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something. |
404 |
This key reaches no such receiver. |
409 |
The project is frozen. |
422 |
Validation Error |
429 |
Too many requests for this key or its organization; see Retry-After. |
500 |
Something went wrong on our side. Quote the request_id to support. |
Examples
#!/bin/sh
# Send a test event
curl -sS --fail-with-body -X POST "https://api.aigently.ai/v1/webhooks/6d8f0a2c-4e6b-4d8f-9a1c-3e5b7d9f1a3c/test" \
-H "Authorization: Bearer $AIGENTLY_API_KEY"
Try it
Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.