Webhooks

Switch a webhook endpoint back on

An endpoint is switched off after 50 failed deliveries in a row. This switches it back on and resets the counter; events from the time it was off are not resent.

post/webhooks/{id}/enable

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/webhooks/{id}/enable
  • 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 endpoint.

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.

Changes

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