v1/webhooks

Register a webhook to be called when new content is encountered on the chain

Changed on
post/v1/webhooks

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

announcementTypesAnnouncementTypeName[] required

Announcement types to send to the webhook

urlstring uri required

Webhook URL

Example request

{
  "announcementTypes": [
    "broadcast",
    "reaction",
    "tombstone",
    "reply",
    "update"
  ],
  "url": "https://example.com/webhook"
}

Changes

    • ▲

      the request property's minItems was increased to 1

    • ▲

      the request property format changed from no format to uri

    • ○

      api operation id WebhookControllerV1_registerWebhook removed and replaced with WebhookControllerV1_registerWebhook_v1

    • ○

      endpoint added