Update a Webhook

Changed on

Update a webhook's endpoint URL, its subscribed event types, or both. Omitted fields are left unchanged. eventTypes replaces the existing subscription rather than adding to it. The signing secret is unaffected.

patch/v1/webhooks/{id}

Request

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

Path parameters

idstring uuid required

The webhook ID.

Request body

endpointstring uri

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

eventTypesstring[]

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

Response

The webhook after the update.

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

Changes