Skip to content

List public webhook event types

GET
/v1/webhooks/events

Return the catalog of event types that can be subscribed to via the public webhook API. Each entry includes a short description and an example payload that the docs site can render without calling the backend.

Authorizations

Parameters

Header Parameters

X-API-Key
Any of:
string

Responses

200

Successful Response

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string