Skip to content

Webhook object

Webhook subscription for receiving event notifications via HTTP POST callbacks

FieldTypeDescription
idrequiredinteger (int32)Unique webhook identifier
urlrequiredstring (uri)Endpoint URL to receive webhook POST requests
eventsrequiredstring[]Event patterns: `*` (all), `users.*`, `*.created`, `users.created`
secretstring | nullShared secret for HMAC-SHA256 signature verification
isActivebooleanWhether the webhook is active
createdAtstring (date-time)Registration timestamp
updatedAtstring (date-time)Last modification timestamp

Released under the MIT License.