Create Lead with Workiz API on New Finished Automation Run from Browserhub API

Pipedream makes it easy to connect APIs for Workiz, Browserhub and 2,200+ other apps remarkably fast.

Trigger workflow on

New Finished Automation Run from the Browserhub API

Next, do this

Create Lead with the Workiz 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#

This integration creates a workflow with a Browserhub trigger and Workiz action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Finished Automation Run trigger
1. Connect your Browserhub account
2. Configure Polling interval
3. Optional- Select a Scraper ID
Configure the Create Lead action
1. Connect your Workiz account
2. Configure Email
3. Optional- Configure Phone
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Company
7. Optional- Configure Address
8. Optional- Configure City
9. Optional- Configure State
10. Optional- Configure Postal Code
11. Optional- Configure Job Datetime
12. Optional- Configure Job Type
13. Optional- Configure Job Source
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Finished Automation Run on Browserhub

Description:Emit new event when an automation run has finished running. [See the documentation](https://developer.browserhub.io/)

Version:0.0.1

Key:browserhub-new-finished-automation-run

View on GitHub

Browserhub Overview#

The Browserhub API offers automation and control over browser sessions, enabling users to create, manipulate, and extract data from web pages programmatically. Integrating Browserhub with Pipedream opens a world of possibilities for automating web interaction workflows, monitoring website changes, scraping data, and testing web applications. Pipedream's serverless platform allows for easy orchestration of API calls and data handling, making it a powerful tool for developers to harness the capabilities of Browserhub in a scalable and efficient manner.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import browserhub from "../../browserhub.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "browserhub-new-finished-automation-run",
  name: "New Finished Automation Run",
  description: "Emit new event when an automation run has finished running. [See the documentation](https://developer.browserhub.io/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    browserhub,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the AskNicely on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    scraperId: {
      propDefinition: [
        browserhub,
        "scraperId",
      ],
      optional: true,
    },
  },
  methods: {
    _getBaseDate() {
      return this.db.get("baseDate");
    },
    _setBaseDate(baseDate = null) {
      this.db.set("baseDate", baseDate);
    },
    async startEvent(maxResults = 0) {
      const baseDate = this._getBaseDate();
      let newBaseDate = null;

      const response = this.browserhub.paginate({
        fn: this.browserhub.listRuns,
        maxResults,
        baseDate,
        params: {
          scraper_id: this.scraperId,
        },
      });

      const responseArray = [];

      for await (const item of response) {
        if (item.status === "successful") responseArray.push(item);
        if (item.status === "running") newBaseDate = item.created_at;
      }

      if (newBaseDate) this._setBaseDate(newBaseDate);
      if (!newBaseDate && responseArray.length) this._setBaseDate(responseArray[0].created_at);

      for (const item of responseArray.reverse()) {
        this.$emit(
          item,
          {
            id: item.id,
            summary: `Successfully finished automation run with ID: ${item.id}`,
            ts: item.created_at,
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

Trigger 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
Browserhub	`browserhub`	`app`	This component uses the Browserhub app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the AskNicely on this schedule
Scraper ID	`scraperId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Browserhub uses API keys for authentication. When you connect your Browserhub account, Pipedream securely stores the keys so you can easily authenticate to Browserhub APIs in both code and no-code steps.

About Browserhub#

Easy to use no-code web scraping and data extraction software.

Action#

Create Lead on Workiz

Description:Create a new lead in Workiz. [See the documentation](https://developer.workiz.com/)

Version:0.0.1

Key:workiz-create-lead

View on GitHub

Workiz Overview#

The Workiz API opens up a world of possibilities for managing field service operations. By tapping into Workiz with Pipedream, you can automate workflows, sync data across apps, and react to events in real-time. Whether you're automating job scheduling, dispatch notifications, or customer follow-ups, integrating Workiz with Pipedream allows you to streamline operations, reduce manual entry, and keep your team in sync.

Action Code#

import workiz from "../../workiz.app.mjs";

export default {
  key: "workiz-create-lead",
  name: "Create Lead",
  description: "Create a new lead in Workiz. [See the documentation](https://developer.workiz.com/)",
  version: "0.0.1",
  type: "action",
  props: {
    workiz,
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the lead",
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Phone number of the lead",
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the lead",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the lead",
      optional: true,
    },
    company: {
      type: "string",
      label: "Company",
      description: "Company name of the lead",
      optional: true,
    },
    address: {
      type: "string",
      label: "Address",
      description: "Street address of the service location",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City of the service location",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State of the service location",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "Postal Code of the service location",
      optional: true,
    },
    leadDateTime: {
      type: "string",
      label: "Job Datetime",
      description: "The datetime of the lead in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2016-08-29T09:12:33.001Z`",
      optional: true,
    },
    jobType: {
      type: "string",
      label: "Job Type",
      description: "The type of job",
      optional: true,
    },
    jobSource: {
      type: "string",
      label: "Job Source",
      description: "The source of job",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.workiz.createLead({
      data: {
        Email: this.email,
        Phone: this.phone,
        FirstName: this.firstName,
        LastName: this.lastName,
        Company: this.company,
        Address: this.address,
        City: this.city,
        PostalCode: this.postalCode,
        LeadDateTime: this.leadDateTime,
        JobType: this.jobType,
        JobSource: this.jobSource,
      },
      $,
    });

    if (response) {
      $.export("$summary", `Successfully created new lead with ID ${response.data[0].UUID}.`);
    }

    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Workiz	`workiz`	`app`	This component uses the Workiz app.
Email	`email`	`string`	Email address of the lead
Phone	`phone`	`string`	Phone number of the lead
First Name	`firstName`	`string`	First name of the lead
Last Name	`lastName`	`string`	Last name of the lead
Company	`company`	`string`	Company name of the lead
Address	`address`	`string`	Street address of the service location
City	`city`	`string`	City of the service location
State	`state`	`string`	State of the service location
Postal Code	`postalCode`	`string`	Postal Code of the service location
Job Datetime	`leadDateTime`	`string`	The datetime of the lead in ISO 8601 format, e.g. `2016-08-29T09:12:33.001Z`
Job Type	`jobType`	`string`	The type of job
Job Source	`jobSource`	`string`	The source of job