Append to record with Data Stores API on New Conversation Started from Vapi API

Pipedream makes it easy to connect APIs for Data Stores, Vapi and 2,700+ other apps remarkably fast.

Trigger workflow on

New Conversation Started from the Vapi API

Next, do this

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

Select this integration
Configure the New Conversation Started trigger
1. Connect your Vapi account
2. Configure timer
Configure the Append to record action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Configure Value
5. Optional- Configure Time to Live (TTL)
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 Conversation Started on Vapi

Description:Emit new event when a voicebot starts a conversation.

Version:0.0.1

Key:vapi-new-conversation

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.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "vapi-new-conversation",
  name: "New Conversation Started",
  description: "Emit new event when a voicebot starts a conversation.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getFunction() {
      return this.vapi.listCalls;
    },
    getSummary(item) {
      return `New Conversation: ${item.id}`;
    },
  },
  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
Vapi	`vapi`	`app`	This component uses the Vapi app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Vapi#

Vapi is the platform to build, test and deploy voicebots in minutes rather than months.

Action#

Append to record on Data Stores

Description:Append to a record in your data store [Pipedream Data Store](https://pipedream.com/data-stores/). If the record does not exist, a new record will be created in an array format.

Version:0.0.3

Key:data_stores-append-to-record

View on GitHub

Data Stores Overview#

Data Stores are a key-value store that allow you to persist state and share data across workflows. You can perform CRUD operations, enabling dynamic data management within your serverless architecture. Use it to save results from API calls, user inputs, or interim data; then read, update, or enrich this data in subsequent steps or workflows. Data Stores simplify stateful logic and cross-workflow communication, making them ideal for tracking process statuses, aggregating metrics, or serving as a simple configuration store.

Action Code#

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

export default {
  key: "data_stores-append-to-record",
  name: "Append to record",
  description: "Append to a record in your data store [Pipedream Data Store](https://pipedream.com/data-stores/). If the record does not exist, a new record will be created in an array format.",
  version: "0.0.3",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter a key for the record set you'd like to append to. Refer to your existing keys [here](https://pipedream.com/data-stores/).",
    },
    value: {
      propDefinition: [
        app,
        "value",
      ],
    },
    ttl: {
      propDefinition: [
        app,
        "ttl",
      ],
    },
  },
  async run({ $ }) {
    const {
      key,
      value,
      ttl,
    } = this;
    const currentValue = await this.dataStore.get(key);
    if (currentValue && !Array.isArray(currentValue)) {
      throw new ConfigurationError("The value for the specified key is not an array. You can only append records to an array.");
    }
    const recordSet = currentValue ?? [];
    const parsedValue = this.app.parseValue(value);
    recordSet.push(parsedValue);

    if (ttl) {
      await this.dataStore.set(key, recordSet, {
        ttl,
      });
      // eslint-disable-next-line multiline-ternary
      $.export("$summary", `Successfully ${currentValue ? "appended to the record for" : "created new record with the"} key: \`${key}\` (expires in ${this.app.formatTtl(ttl)}).`);
    } else {
      await this.dataStore.set(key, recordSet);
      // eslint-disable-next-line multiline-ternary
      $.export("$summary", `Successfully ${currentValue ? "appended to the record for" : "created new record with the"} key: \`${key}\`.`);
    }

    return {
      key,
      value: parsedValue,
      ttl: ttl || null,
    };
  },
};

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
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Value	`value`	`any`	Enter a string, object, or array.
Time to Live (TTL)	`ttl`	`integer`	The number of seconds until this record expires and is automatically deleted. Examples: 3600 (1 hour), 86400 (1 day), 604800 (1 week). Leave blank for records that should not expire.