Webhooks

Send a test event

Immediately sends a webhook.test event to the endpoint and reports the result. When it fails, we retry it like any other delivery: up to 8 attempts over about 45 hours, or 3 attempts within about 6 minutes for an endpoint of a test project.

post/webhooks/{id}/test

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/webhooks/{id}/test
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: webhooks:write)

Path parameters

idstring uuid required

The id of the webhook endpoint.

Response

The outcome of the first delivery.

delivery_idstring uuid required
event_idstring required

The id of the webhook.test event, evt_ plus 32 hex characters.

status'delivered' | 'pending' | 'failed' required

delivered: your endpoint answered 2xx. pending: it did not, and we retry with backoff. failed: we gave up.

response_statusinteger nullable required

The HTTP status your endpoint answered with, if any.

error'timeout' | 'connection_failed' | 'non_2xx_status' | 'not_public_host' | 'invalid_url' | 'response_too_large' | 'secret_unreadable' | 'endpoint_disabled' | 'call_deleted' | 'summary_deleted' | 'message_deleted' | 'conversation_deleted' | 'document_deleted' | 'invalid_reference' | 'delivery_failed' | 'null' nullable required

Why the delivery did not succeed, as a short code.

Changes

No recorded changes to this operation across all 1 revision of this API.