Register a webhook endpoint
POST
/webhooks
const url = 'https://api.bizzle.my/v1/webhooks';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"url":"https://example.com","events":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.bizzle.my/v1/webhooks \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "url": "https://example.com", "events": [ "example" ] }'Registers an endpoint that receives signed event deliveries. The signing
secret is returned once and may be rotated via
/webhooks/{id}/rotate-secret.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Idempotency-Key
string
Unique identifier used to replay requests safely.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
url
required
string format: uri
events
Array<string>
Example generated
{ "url": "https://example.com", "events": [ "example" ]}Responses
Section titled “Responses”Webhook endpoint created.
Media typeapplication/json
object
object
string
data
array
has_more
boolean
Example
{ "object": "list"}Too many requests.
Media typeapplication/json
object
error
required
string
message
string
code
string
details
object
Example generated
{ "error": "example", "message": "example", "code": "example", "details": {}}Headers
Section titled “Headers”RateLimit-Limit
integer
Maximum requests per window.
RateLimit-Remaining
integer
Requests remaining in the current window.
RateLimit-Reset
integer
Unix seconds when the window resets.
Retry-After
integer
Seconds to wait before retrying (on 429/handled outages).