Create Customer with Teamwork Desk API on New Document from MongoDB API

Pipedream makes it easy to connect APIs for Teamwork Desk, MongoDB and 2,400+ other apps remarkably fast.

Trigger workflow on

New Document from the MongoDB API

Next, do this

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

Select this integration
Configure the New Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Configure Timestamp Field
Configure the Create Customer action
1. Connect your Teamwork Desk account
2. Optional- Configure Address
3. Optional- Configure Avatar URL
4. Select a Company
5. Configure Email
6. Optional- Configure External Id
7. Optional- Configure Extra Data
8. Optional- Configure Facebook URL
9. Optional- Configure First Name
10. Optional- Configure Job Title
11. Optional- Configure Last Name
12. Optional- Configure LinkedinURL
13. Optional- Configure Mobile
14. Optional- Configure Notes
15. Optional- Configure Organization
16. Optional- Select a Permission
17. Optional- Configure Phone
18. Optional- Configure Twitter Handle
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 Document on MongoDB

Description:Emit new an event when a new document is added to a collection

Version:0.0.9

Key:mongodb-new-document

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

import common from "../common/base.mjs";
import { Timestamp } from "mongodb";

export default {
  ...common,
  key: "mongodb-new-document",
  name: "New Document",
  description: "Emit new an event when a new document is added to a collection",
  version: "0.0.9",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    timestampField: {
      type: "string",
      label: "Timestamp Field",
      description: "The key of a timestamp field, such as 'created_at' that is set to the current timestamp when a document is created. Must be of type Timestamp.",
    },
  },
  hooks: {
    async deploy() {
      const client = await this.mongodb.getClient();
      await this.processEvent(client, Date.now(), 25);
      await client.close();
    },
  },
  methods: {
    ...common.methods,
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    getTs(doc) {
      try {
        return JSON.parse(doc[this.timestampField]);
      } catch {
        return doc[this.timestampField];
      }
    },
    convertToTimestamp(timestampStr) {
      const bigIntValue = BigInt(timestampStr);
      const seconds = Number(bigIntValue >> 32n);
      const increment = Number(bigIntValue & 0xFFFFFFFFn);
      return new Timestamp({
        t: seconds,
        i: increment,
      });
    },
    async processEvent(client, eventTs, max) {
      const lastTs = this._getLastTs() || 0;
      let maxTs = lastTs;
      let count = 0;
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const sort = {
        [this.timestampField]: -1,
      };
      const query = {
        [this.timestampField]: {
          $gt: this.convertToTimestamp(lastTs),
        },
      };
      const documents = await collection.find(query).sort(sort)
        .toArray();
      const docs = [];
      for (const doc of documents) {
        const ts = this.getTs(doc);
        if (!(ts > lastTs) || (max && count >= max)) {
          break;
        }
        if (ts > maxTs) {
          maxTs = ts;
        }
        docs.push(doc);
        count++;
      }
      docs.reverse().forEach((doc) => this.emitEvent(doc, eventTs));
      this._setLastTs(maxTs);
    },
    generateMeta({ _id: id }, ts) {
      return {
        id,
        summary: `New Document ID ${JSON.stringify(id)}`,
        ts,
      };
    },
  },
};

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
MongoDB	`mongodb`	`app`	This component uses the MongoDB 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 API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
Timestamp Field	`timestampField`	`string`	The key of a timestamp field, such as 'created_at' that is set to the current timestamp when a document is created. Must be of type Timestamp.

Trigger Authentication#

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

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Create Customer on Teamwork Desk

Description:Create a new customer [See the documentation](https://apidocs.teamwork.com/docs/desk/fe69a0fb1007a-create-a-new-customer)

Version:0.0.1

Key:teamwork_desk-create-customer

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.

Action Code#

import teamworkDesk from "../../teamwork_desk.app.mjs";

export default {
  key: "teamwork_desk-create-customer",
  name: "Create Customer",
  version: "0.0.1",
  description: "Create a new customer [See the documentation](https://apidocs.teamwork.com/docs/desk/fe69a0fb1007a-create-a-new-customer)",
  type: "action",
  props: {
    teamworkDesk,
    address: {
      propDefinition: [
        teamworkDesk,
        "address",
      ],
      optional: true,
    },
    avatarURL: {
      propDefinition: [
        teamworkDesk,
        "avatarURL",
      ],
      optional: true,
    },
    companyId: {
      propDefinition: [
        teamworkDesk,
        "companyId",
      ],
    },
    email: {
      propDefinition: [
        teamworkDesk,
        "email",
      ],
    },
    externalId: {
      propDefinition: [
        teamworkDesk,
        "externalId",
      ],
      optional: true,
    },
    extraData: {
      propDefinition: [
        teamworkDesk,
        "extraData",
      ],
      optional: true,
    },
    facebookURL: {
      propDefinition: [
        teamworkDesk,
        "facebookURL",
      ],
      optional: true,
    },
    firstName: {
      propDefinition: [
        teamworkDesk,
        "firstName",
      ],
      optional: true,
    },
    jobTitle: {
      propDefinition: [
        teamworkDesk,
        "jobTitle",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        teamworkDesk,
        "lastName",
      ],
      optional: true,
    },
    linkedinURL: {
      propDefinition: [
        teamworkDesk,
        "linkedinURL",
      ],
      optional: true,
    },
    mobile: {
      propDefinition: [
        teamworkDesk,
        "mobile",
      ],
      optional: true,
    },
    notes: {
      propDefinition: [
        teamworkDesk,
        "notes",
      ],
      optional: true,
    },
    organization: {
      propDefinition: [
        teamworkDesk,
        "organization",
      ],
      optional: true,
    },
    permission: {
      propDefinition: [
        teamworkDesk,
        "permission",
      ],
      optional: true,
    },
    phone: {
      propDefinition: [
        teamworkDesk,
        "phone",
      ],
      optional: true,
    },
    twitterHandle: {
      propDefinition: [
        teamworkDesk,
        "twitterHandle",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      teamworkDesk,
      companyId,
      email,
      ...data
    } = this;

    const response = await teamworkDesk.createCustomer({
      $,
      data: {
        customer: data,
        included: {
          companies: [
            {
              id: companyId,
              delete: false,
            },
          ],
          contacts: [
            {
              value: email,
              type: "email",
              isMain: true,
            },
          ],
        },
      },
    });

    $.export("$summary", `A new customer with Id: ${response.customer?.id} was successfully created!`);
    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
Teamwork Desk	`teamworkDesk`	`app`	This component uses the Teamwork Desk app.
Address	`address`	`string`	Customer address.
Avatar URL	`avatarURL`	`string`	Customer avatar URL.
Company	`companyId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	The email address of the customer. Email ticket replies and chat transcriptions will be sent to the customer at this address.
External Id	`externalId`	`string`	Customer external ID.
Extra Data	`extraData`	`string`	Provides a free-form reference field for additional customer information.
Facebook URL	`facebookURL`	`string`	The Facebook URL address of the customer.
First Name	`firstName`	`string`	The first name of the customer.
Job Title	`jobTitle`	`string`	Customer job title.
Last Name	`lastName`	`string`	The last name of the customer.
LinkedinURL	`linkedinURL`	`string`	The Linkedin URL address of the customer.
Mobile	`mobile`	`string`	The customer mobile.
Notes	`notes`	`string`	Provides a free-form reference field for additional customer information.
Organization	`organization`	`string`	Organization is the name of the organization that the Customer is in. This feature has been deprecated in favor of `companies`.
Permission	`permission`	`string`	Select a value from the drop down menu:`ownall`
Phone	`phone`	`string`	Customer phone.
Twitter Handle	`twitterHandle`	`string`	The Twitter Handle of the customer.

Action 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:

Create Customer with Teamwork Desk API on New Document from MongoDB API

Pipedream makes it easy to connect APIs for Teamwork Desk, MongoDB and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular