Skip to main content
POST
Node.js

Authorizations

X-BB-API-Key
string
header
required

Body

application/json
endpoint
string<uri>
required

HTTPS URL that event deliveries are POSTed to. Must be publicly reachable.

Maximum string length: 2048
Pattern: ^https://[^/?#]+
eventTypes
enum<string>[]
required

Event types this webhook subscribes to. Unknown types are rejected.

Minimum array length: 1
Available options:
functions.builds.running,
functions.builds.completed,
functions.builds.failed,
functions.invocations.pending,
functions.invocations.running,
functions.invocations.completed,
functions.invocations.failed

Response

201 - application/json

The webhook has been created.

The created webhook, including its signing secret.

id
string
required

Unique identifier for the webhook.

projectId
string
required

The project the webhook belongs to.

endpoint
string<uri>
required

HTTPS URL that event deliveries are POSTed to. Must be publicly reachable.

Maximum string length: 2048
Pattern: ^https://[^/?#]+
eventTypes
enum<string>[]
required

Event types this webhook subscribes to. Unknown types are rejected.

Minimum array length: 1
Available options:
functions.builds.running,
functions.builds.completed,
functions.builds.failed,
functions.invocations.pending,
functions.invocations.running,
functions.invocations.completed,
functions.invocations.failed
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
secret
string
required

HMAC-SHA256 signing secret, prefixed whsec_. Shown once here; store it now. Use it to verify the signature on every delivery.