API Referencewebhooks

Test a webhook

View as Markdown
Queue a signed test event for a webhook endpoint and return its delivery record.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

webhookIdstringRequired
Unique webhook identifier generated by BCTRL.

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Response

Accepted
attemptCountinteger>=0
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
eventIdstring
Unique runEvent identifier generated by BCTRL.
eventTypestring
idstring
Unique webhookDelivery identifier generated by BCTRL.
lastErrorstring or null
nextAttemptAtdatetime or null
RFC 3339 timestamp with a UTC offset.
responseStatusinteger or null100-599
sentAtdatetime or null
RFC 3339 timestamp with a UTC offset.
statusenum
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.
webhookIdstring or null

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error