Webhooks

Register a webhook

Returns an HMAC signing secret ONCE. Subscribe to named events or to ["*"]. Requires webhooks:write.

post/client/webhooks

Request

  • Base URL: https://api.roar-ai.com
  • URL: https://api.roar-ai.com/client/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Public https endpoint

eventsWebhookSubscription[]
descriptionstring

Response

The created webhook (secret shown once)

idstring uuid required
urlstring uri required
eventsWebhookSubscription[] required
descriptionstring nullable required
enabledboolean required
createdAtstring date-time required
secretstring required

HMAC signing secret — shown once

warningstring required

Changes

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