Create Call with Vapi API on New Test Run from TestLocally API

Pipedream makes it easy to connect APIs for Vapi, TestLocally and 2,800+ other apps remarkably fast.

Trigger workflow on

New Test Run from the TestLocally API

Next, do this

Create Call with the Vapi 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 TestLocally trigger and Vapi action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Test Run trigger
1. Connect your TestLocally account
2. Configure timer
3. Optional- Configure Owners
4. Optional- Configure Locations
5. Optional- Configure Target
6. Optional- Configure Scheduled
7. Optional- Select a Browser
8. Optional- Select a Viewport
Configure the Create Call action
1. Connect your Vapi account
2. Optional- Configure Conversation Name
3. Optional- Select a Assistant ID
4. Optional- Select a Squad ID
5. Select a Phone Number ID
6. Optional- Configure Customer ID
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 Test Run on TestLocally

Description:Emit new event when a new test is run or completed in TestLocally. [See the documentation](https://testlocally.readme.io/reference/api_v0_recent_tests)

Version:0.0.1

Key:testlocally-new-test-run

View on GitHub

Trigger Code#

import testlocally from "../../testlocally.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "testlocally-new-test-run",
  name: "New Test Run",
  description: "Emit new event when a new test is run or completed in TestLocally. [See the documentation](https://testlocally.readme.io/reference/api_v0_recent_tests)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    testlocally,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    owners: {
      propDefinition: [
        testlocally,
        "owners",
      ],
    },
    locations: {
      propDefinition: [
        testlocally,
        "locations",
      ],
    },
    target: {
      propDefinition: [
        testlocally,
        "target",
      ],
    },
    scheduled: {
      propDefinition: [
        testlocally,
        "scheduled",
      ],
    },
    browser: {
      propDefinition: [
        testlocally,
        "browser",
      ],
    },
    viewport: {
      propDefinition: [
        testlocally,
        "viewport",
      ],
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs") || 0;
    },
    _setLastTs(ts) {
      this.db.set("lastTs", ts);
    },
    generateMeta(test) {
      return {
        id: test.id,
        summary: `New Test Run ID: ${test.id}`,
        ts: test.created,
      };
    },
    async processEvent(max) {
      const lastTs = this._getLastTs();
      const results = this.testlocally.paginate({
        fn: this.testlocally.listTests,
        args: {
          params: {
            owners: parseObject(this.owners),
            locations: parseObject(this.locations),
            target: this.target,
            scheduled: this.scheduled,
            browser: this.browser,
            viewport: this.viewport,
          },
        },
        max,
      });

      const tests = [];
      for await (const test of results) {
        if (test.created > lastTs) {
          tests.push(test);
        } else {
          break;
        }
      }

      if (!tests.length) {
        return;
      }

      this._setLastTs(tests[0].created);

      tests.reverse().forEach((test) => {
        const meta = this.generateMeta(test);
        this.$emit(test, meta);
      });
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  async run() {
    await this.processEvent();
  },
  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
TestLocally	`testlocally`	`app`	This component uses the TestLocally app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Owners	`owners`	`string[]`	A list of userIds of the owners of the tests to retrieve
Locations	`locations`	`string[]`	A list of locations of the tests to retrieve
Target	`target`	`string`	The target URL of the tests to retrieve
Scheduled	`scheduled`	`string`	The scheduled status of the tests to retrieve. Values: 'yes', 'no', or a specific schedule ID
Browser	`browser`	`string`	Select a value from the drop down menu:`chromiumchromefirefoxmsedgewebkit`
Viewport	`viewport`	`string`	Select a value from the drop down menu:`desktoptabletphone`

Trigger Authentication#

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

About TestLocally#

See what your website looks like from anywhere

Action#

Create Call on Vapi

Description:Starts a new conversation with an assistant. [See the documentation](https://docs.vapi.ai/api-reference/calls/create)

Version:0.0.1

Key:vapi-create-call

View on GitHub

Vapi Overview#

The Vapi API delivers voice automation capabilities, letting you build powerful voice response systems. With Vapi, you can automate calls, send voice messages, and create dynamic interactions through speech recognition and text-to-speech. Pipedream's serverless platform allows you to integrate Vapi's API with numerous other services to automate workflows, react to events, and orchestrate complex voice-enabled processes.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import vapi from "../../vapi.app.mjs";

export default {
  key: "vapi-create-call",
  name: "Create Call",
  description: "Starts a new conversation with an assistant. [See the documentation](https://docs.vapi.ai/api-reference/calls/create)",
  version: "0.0.1",
  type: "action",
  props: {
    vapi,
    name: {
      type: "string",
      label: "Conversation Name",
      description: "Name of the new conversation",
      optional: true,
    },
    assistantId: {
      propDefinition: [
        vapi,
        "assistantId",
      ],
      optional: true,
    },
    squadId: {
      propDefinition: [
        vapi,
        "squadId",
      ],
      optional: true,
    },
    phoneNumberId: {
      propDefinition: [
        vapi,
        "phoneNumberId",
      ],
    },
    customerId: {
      type: "string",
      label: "Customer ID",
      description: "ID of the customer for the conversation",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.assistantId && !this.squadId) {
      throw new ConfigurationError("Specify either `Assistant Id` or `Squad Id`");
    }

    const response = await this.vapi.startConversation({
      $,
      data: {
        assistantId: this.assistantId,
        squadId: this.squadId,
        phoneNumberId: this.phoneNumberId,
        name: this.name,
        customerId: this.customerId,
      },
    });
    $.export("$summary", `Conversation created with ID ${response.id}`);
    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
Vapi	`vapi`	`app`	This component uses the Vapi app.
Conversation Name	`name`	`string`	Name of the new conversation
Assistant ID	`assistantId`	`string`	Select a value from the drop down menu.
Squad ID	`squadId`	`string`	Select a value from the drop down menu.
Phone Number ID	`phoneNumberId`	`string`	Select a value from the drop down menu.
Customer ID	`customerId`	`string`	ID of the customer for the conversation