Get a Webhook - Browserbase Documentation

GET

/

v1

/

webhooks

/

{id}

Node.js

import Browserbase from "@browserbasehq/sdk";

const bb = new Browserbase({
  apiKey: process.env.BROWSERBASE_API_KEY,
});

const webhook = await bb.webhooks.retrieve("<webhook-id>");

console.log(webhook);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BB-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/webhooks/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BB-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "projectId": "<string>",
  "endpoint": "<string>",
  "eventTypes": [
    "functions.builds.running"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-BB-API-Key

string

header

required

Your Browserbase API Key.

Path Parameters

id

string<uuid>

required

The webhook ID.

Response

200 - application/json

The webhook.

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

⌘I

Node.js

import Browserbase from "@browserbasehq/sdk";

const bb = new Browserbase({
  apiKey: process.env.BROWSERBASE_API_KEY,
});

const webhook = await bb.webhooks.retrieve("<webhook-id>");

console.log(webhook);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BB-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/webhooks/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BB-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "projectId": "<string>",
  "endpoint": "<string>",
  "eventTypes": [
    "functions.builds.running"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}