Append to record with Data Stores API on New Call Event Received (Instant) from CallHub API

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

Trigger workflow on

New Call Event Received (Instant) from the CallHub 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 CallHub 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 Call Event Received (Instant) trigger
1. Connect your CallHub account
2. Select a Event Type
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 Call Event Received (Instant) on CallHub

Description:Emit new event when a call event of the type specified is received. [See the docs](https://developer.callhub.io/reference/create-new-webhook)

Version:0.0.1

Key:callhub-new-call-event-received

View on GitHub

CallHub Overview#

The CallHub API offers programmatic access to a range of telecommunication features, such as phone banking, text messaging, and voice broadcasting. Integrating CallHub with Pipedream allows users to automate these communication services within custom workflows. With Pipedream’s serverless platform, you can react to events across various apps, store and manipulate data, and trigger communications via CallHub based on user-defined criteria. This seamless integration expands the automation possibilities for campaign management, engagement tracking, and proactive notifications.

Trigger Code#

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

export default {
  key: "callhub-new-call-event-received",
  name: "New Call Event Received (Instant)",
  description: "Emit new event when a call event of the type specified is received. [See the docs](https://developer.callhub.io/reference/create-new-webhook)",
  version: "0.0.1",
  dedupe: "unique",
  type: "source",
  props: {
    callhub,
    db: "$.service.db",
    http: "$.interface.http",
    eventType: {
      propDefinition: [
        callhub,
        "eventType",
      ],
    },
  },
  hooks: {
    async activate() {
      const { id } = await this.callhub.createWebhook({
        data: {
          event: this.eventType,
          target: this.http.endpoint,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const hookId = this._getHookId();
      await this.callhub.deleteWebhook(hookId);
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    generateMeta() {
      return {
        id: Date.now(),
        summary: "New event received",
        ts: Date.now(),
      };
    },
  },
  async run(event) {
    const { body: { data } } = event;

    const meta = this.generateMeta(data);

    this.$emit(data, meta);
  },
};

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
CallHub	`callhub`	`app`	This component uses the CallHub app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Event Type	`eventType`	`string`	Select a value from the drop down menu:`{ "label": "Voice Broadcast - Transfer Digit Pressed", "value": "vb.transfer" }{ "label": "Text Reply Received", "value": "sb.reply" }{ "label": "Call Center - Note Entered by Agent", "value": "cc.notes" }{ "label": "Agent Activates Their Account", "value": "agent.activation" }`

Trigger Authentication#

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

To retrieve your API Key,

Navigate to your CallHub account and sign in
Click on the user menu on the top right with your Email
Go to “Profile” > “API Key”

About CallHub#

The all-in-one digital organizing platform for political campaigns, nonprofits & businesses.

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.