Webhooks

Subscribe to events

Registers an endpoint to receive events. The secret is returned only here: store it, and verify the BB-Signature header on every delivery. Returns a Location header pointing at the subscription.

post/webhooks

Request

  • Base URL: https://api.marubox.jp/v1
  • URL: https://api.marubox.jp/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
descriptionstring

Response

Default Response

idstring required
urlstring required
eventsstring[] required
descriptionstring nullable required
status'active' | 'disabled' required
createdViastring required
lastSuccessAtstring nullable required
consecutiveFailuresinteger required
createdAtstring required
secretstring required

Changes

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