Webhooks

Register a webhook endpoint

Requires webhooks:w.

post/v1/webhooks

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

urlstring uri required

HTTPS URL to deliver events to. It must answer 2xx directly: deliveries never follow a redirect, so a 3xx is recorded as a failed attempt.

eventsstring[] required

Response

The endpoint. signing_secret is shown only here: store it to verify X-HonkIO-Signature.

idstring required
urlstring required
eventsstring[] required
signing_secretstring required

64 hex characters.

activeboolean required
created_atstring date-time required
noticestring required

Changes

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