SIsiafoundation
webhooks

Register webhook

Registers a new webhook with the specified callback URL and event scopes.

post/webhooks

Request

  • Base URL
    http://localhost:9980/api
  • URL
    http://localhost:9980/api/webhooks
  • Auth
    HTTP basic

Request body

callbackURLstring uri required

URL that will receive webhook event POST requests.

scopesstring[] required

Event scopes to subscribe to.

Response

Webhook registered.

idinteger required

Unique identifier of the webhook.

callbackURLstring uri required

URL that receives webhook event POST requests.

secretKeystring required

Secret key used for webhook request authentication via HTTP Basic Auth.

scopesstring[] required

Event scopes the webhook is subscribed to.

Changes

No recorded changes to this operation across all 15 revisions of this API.