Create Session with Browserbase API

Pipedream makes it easy to connect APIs for Browserbase and 2,900+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Session with the Browserbase API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Session with the Browserbase API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Session action
1. Connect your Browserbase account
2. Select a Project ID
3. Optional- Configure Extension ID
4. Optional- Configure Browser Settings
5. Optional- Configure Timeout
6. Optional- Configure Keep Alive
7. Optional- Configure Proxies
8. Optional- Select a Region
9. Optional- Configure User Metadata
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Session with Browserbase API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Browserbase

Try it

Create Session with Browserbase API on New Submission from Typeform API

Typeform + Browserbase

Try it

Create Session with Browserbase API on New Submission (Instant) from Jotform API

Jotform + Browserbase

Try it

Create Session with Browserbase API on New Scheduled Tasks from Pipedream API

Pipedream + Browserbase

Try it

Create Session with Browserbase API on New Download Counts from npm API

npm + Browserbase

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Session on Browserbase

Description:Creates a new browser session with specified settings. [See the documentation](https://docs.browserbase.com/reference/api/create-a-session)

Version:0.0.2

Key:browserbase-create-session

View on GitHub

Code#

import browserbase from "../../browserbase.app.mjs";
import { REGION_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "browserbase-create-session",
  name: "Create Session",
  description: "Creates a new browser session with specified settings. [See the documentation](https://docs.browserbase.com/reference/api/create-a-session)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    browserbase,
    projectId: {
      propDefinition: [
        browserbase,
        "projectId",
      ],
    },
    extensionId: {
      type: "string",
      label: "Extension ID",
      description: "The uploaded Extension ID",
      optional: true,
    },
    browserSettings: {
      type: "object",
      label: "Browser Settings",
      description: "An object with the settings for the session. [See the documentation](https://docs.browserbase.com/reference/api/create-a-session#body-browser-settings) for more details.",
      optional: true,
    },
    timeout: {
      type: "integer",
      label: "Timeout",
      description: "Duration in seconds after which the session will automatically end.",
      min: 60,
      max: 21600,
      optional: true,
    },
    keepAlive: {
      type: "boolean",
      label: "Keep Alive",
      description: "Set to true to keep the session alive even after disconnections.",
      optional: true,
    },
    proxies: {
      type: "string[]",
      label: "Proxies",
      description: "An array of objects with proxy configuration. [See the documentation](https://docs.browserbase.com/reference/api/create-a-session#body-proxies) for more details.",
      optional: true,
    },
    region: {
      type: "string",
      label: "Region",
      description: "The region where the session should run.",
      options: REGION_OPTIONS,
      optional: true,
    },
    userMetadata: {
      type: "object",
      label: "User Metadata",
      description: "Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](https://docs.browserbase.com/features/sessions#user-metadata).",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.browserbase.createSession({
      $,
      data: {
        projectId: this.projectId,
        extensionId: this.extensionId,
        browserSettings: parseObject(this.browserSettings),
        timeout: this.timeout,
        keepAlive: this.keepAlive,
        proxies: parseObject(this.proxies),
        region: this.region,
        userMetadata: parseObject(this.userMetadata),
      },
    });

    $.export("$summary", `Session created successfully with ID: ${response.id}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Browserbase	`browserbase`	`app`	This component uses the Browserbase app.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Extension ID	`extensionId`	`string`	The uploaded Extension ID
Browser Settings	`browserSettings`	`object`	An object with the settings for the session. See the documentation for more details.
Timeout	`timeout`	`integer`	Duration in seconds after which the session will automatically end.
Keep Alive	`keepAlive`	`boolean`	Set to true to keep the session alive even after disconnections.
Proxies	`proxies`	`string[]`	An array of objects with proxy configuration. See the documentation for more details.
Region	`region`	`string`	Select a value from the drop down menu:`{ "label": "US West 2", "value": "us-west-2" }{ "label": "US East 1", "value": "us-east-1" }{ "label": "EU Central 1", "value": "eu-central-1" }{ "label": "AP Southeast 1", "value": "ap-southeast-1" }`
User Metadata	`userMetadata`	`object`	Arbitrary user metadata to attach to the session. To learn more about user metadata, see User Metadata