Webhooks

Create a webhook endpoint

Create a webhook endpoint. The signing secret is returned once, in this response, and never again; rotate it to get a new one. Up to 10 endpoints per workspace.

post/api/webhooks

Request

  • Base URL: https://api.donebear.com
  • URL: https://api.donebear.com/api/webhooks
  • Auth: HTTP bearer

Headers

Api-Version'1'

Pin the API version. Omit it to get the current version. A version this server does not serve is refused with 400 rather than answered by another one.

Request body

descriptionstring
eventTypesstring[]

Omit or send empty to receive every event type.

urlstring uri required

Public HTTPS URL. Private and loopback addresses are refused.

workspaceIdstring uuid required

Response

The endpoint and its secret.

okboolean required
secretstring required

whsec_-prefixed signing secret. Shown once.

Changes

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