Skip to main content
PATCH
Node.js

Authorizations

X-BB-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

The webhook ID.

Body

application/json
endpoint
string<uri>

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

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

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

200 - application/json

The webhook after the update.

A delivery endpoint for a project. Browserbase POSTs a signed event to it whenever one of its subscribed event types occurs. The signing secret is returned only when it is created or rotated.

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