Append to record with Data Stores API on New Customer Created from Teamwork Desk API

Pipedream makes it easy to connect APIs for Data Stores, Teamwork Desk and 2,200+ other apps remarkably fast.

Trigger workflow on

New Customer Created from the Teamwork Desk 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 Teamwork Desk 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 Customer Created trigger
1. Connect your Teamwork Desk account
2. Select one or more Inboxes
Configure the Append to record action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Configure Value
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 Customer Created on Teamwork Desk

Description:Emit new event when a new customer is created.

Version:0.0.1

Key:teamwork_desk-customer-created

View on GitHub

Teamwork Desk Overview#

The Teamwork Desk API provides the means to programmatically access and manipulate customer support ticket data. By integrating it with Pipedream, you can automate ticketing workflows, streamline customer interactions, and connect support data with other business tools. Whether syncing tickets to a CRM, setting up custom alerts, or generating reports, the API's capabilities allow for a variety of automations to enhance support operations.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  name: "New Customer Created",
  key: "teamwork_desk-customer-created",
  type: "source",
  description: "Emit new event when a new customer is created.",
  version: "0.0.1",
  methods: {
    ...common.methods,
    getWebhookEvents() {
      return [
        "customer.created",
      ];
    },
    getMetadata({
      customer: {
        id, createdAt,
      },
    }) {
      return {
        id: id,
        summary: `A new customer with id ${id} was successfully created!`,
        ts: createdAt,
      };
    },
  },
};

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
Teamwork Desk	`teamworkDesk`	`app`	This component uses the Teamwork Desk 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.
Inboxes	`inboxes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Teamwork Desk uses OAuth authentication. When you connect your Teamwork Desk account, Pipedream will open a popup window where you can sign into Teamwork Desk and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Teamwork Desk API.

Pipedream requests the following authorization scopes when you connect your account:

About Teamwork Desk#

Ticketing system designed to easily manage customer queries, saving you time and money.

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.2

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.2",
  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",
      ],
    },
  },
  async run({ $ }) {
    const {
      key,
      value,
    } = 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);
    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,
    };
  },
};

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.