Webhooks

Create a webhook

Registers a webhook for asynchronous model generation events. The response is the only time signatureSecret is returned.

post/events/webhooks

Request

  • Base URL: https://api.sandbase.ai
  • URL: https://api.sandbase.ai/events/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

namestring required
urlstring uri required

HTTP(S) endpoint. Use HTTPS in production.

resourceType'model' required
eventsstring[]

Empty or omitted means all current and future events in the resource type.

enabledboolean
signatureSecretstring

Optional. Omit to let SandBase generate a high-entropy secret.

Response

Webhook created

idstring required
namestring required
urlstring uri required
resourceTypestring required

model for new registrations. Retired types (session, sandbox, template) can still appear on old registrations.

eventsstring[] required

Empty means all events in the resource type.

enabledboolean required
createdAtstring date-time required
signatureSecretstring required

HMAC signing secret. Returned only in this response.

Changes

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