Send a Test Delivery
Changed onQueues one synthetic delivery so an endpoint and its signature check can be verified before a real trigger fires. It uses the same queue, signing and attempt logging as a real delivery; only the body is synthetic, and its event is the reserved key webhook.test.
Delivery semantics. Delivery is at-least-once: the same envelope can arrive more than once, so deduplicate on the envelope's id, which is stable across retries and equal to X-Monaco-Delivery. Order is not guaranteed. The envelope's version increases with every change to the entity, so ignore an envelope whose version is not greater than the last one you applied to that entity. Any 2xx acknowledges the delivery; anything else is retried about 10s, 20s and 40s later and then dead-lettered, except a 4xx other than 408 and 429, which is terminal and never retried. Redirects are not followed, and the request times out after 10s.
Error codes
| error.code | HTTP | Cause | What to do |
|---|---|---|---|
| subscription_paused | 409 | The subscription is paused, so the delivery would be dropped before it was sent. | Resume it with PATCH /v1/webhooks/subscriptions/{id}. |
| not_found | 422 | No subscription with this id exists in the calling org. | Check the id; a deleted subscription is never returned. |
Request
- Base URLhttps://api.monaco.com
- URLhttps://api.monaco.com/v1/webhooks/subscriptions/{subscription_id}/test
- Authnone declared
Path parameters
Response
Successful Response
Example response
{
"data": {
"delivered_event_id": "test_0199c0ff-..."
}
}Changes
- info
endpoint added
- info