Webhooks

Create a webhook endpoint

Creates an endpoint that receives the events you choose, signed with Hypamoon-Signature. The secret is in this response only. At most 10 endpoints per project.

post/webhooks

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/webhooks
  • 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)

Request body

urlstring required

An https URL with a domain name on the default port, without credentials, that resolves to a public address.

eventsstring[] required

The events to receive, from call.completed, call.summary.ready, message.delivered, message.failed, conversation.summary.ready, balance.low, balance.topped_up, balance.reload_failed, document.created, email.sent, email.delivered, email.delayed, email.bounced, email.complained. The email events come once per recipient.

app_idstring uuid

Optional, for email events only: receive only the email events of emails this app sent (an id from list_apps). Without it, the endpoint gets the events of every email of the project.

Response

The endpoint, with its secret.

idstring uuid required
urlstring required
eventsstring[] required

The subscribed events, from call.completed, call.summary.ready, message.delivered, message.failed, conversation.summary.ready, balance.low, balance.topped_up, balance.reload_failed, document.created.

activeboolean required

false after 50 failed deliveries in a row; switch it back on with POST /webhooks/{id}/enable.

secret_prefixstring required

The first characters of the secret, to recognize it.

created_atstring date-time required

When the endpoint was created.

last_success_atstring date-time nullable required

The last delivery that got a 2xx.

last_failure_atstring date-time nullable required

The last delivery that failed.

consecutive_failuresinteger required

Failed deliveries in a row.

app_idstring uuid

Only with a filter on one app: the endpoint gets the email events of that app's emails only.

secretstring required

The signing secret, whsec_ plus 43 characters. Shown only in this response: store it now.

Changes

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