Test webhook

POST/api/v1/webhooks/{id}/test

Sends a ping to the URL immediately and responds with the result. Not retried.

Scope

webhooks:write Edit webhooks – the person behind the key must be administrator.

Path parameters

idstringrequired: The webhook's ID.

Retrying a request

Feel free to send the Idempotency-Key header (e.g. a UUID). If the same request is sent again with the same key within 24 hours, the first response is returned, without anything being done twice. Batch and idempotency

Response

200 The result.

delivery_idstringrequired
okbooleanrequired: The receiver responded 2xx.
response_statusinteger | nullrequired
errorstring | nullrequired

Errors

401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
404: not_found
409: idempotency_in_progress
422: idempotency_key_reused
429: rate_limited
500: internal_error

Request

curl -X POST 'https://newsletter.qrona.se/api/v1/webhooks/5e2d9b7c-1a3f-4c6e-8d0b-2f4a6c8e0b1d/test' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY"

Response 200

{
  "delivery_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "ok": true,
  "response_status": 200,
  "error": null
}