BRbrowserbase

Create a Webhook

Changed on

Register an HTTPS endpoint to receive events for this project. The response includes the signing secret, which is shown only here and when the secret is rotated. Store it before discarding the response. An endpoint may only be registered once per project.

post/v1/webhooks

Request

  • Base URL
    https://api.browserbase.com
  • Auth
    API key in header X-BB-API-Key

Request body

endpointstring uri required

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

eventTypesstring[] required

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

Response

The webhook has been created.

idstring required

Unique identifier for the webhook.

projectIdstring required

The project the webhook belongs to.

endpointstring uri required

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

eventTypesstring[] required

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

createdAtstring date-time required
updatedAtstring date-time required
secretstring required

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

Changes