Create Customer with Teamwork Desk API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Create Customer with the Teamwork Desk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Customer with Teamwork Desk API on New Form Submission from Gravity Forms API

Gravity Forms + Teamwork Desk

Try it

Create Customer with Teamwork Desk API on New Requests from HTTP / Webhook API

HTTP / Webhook + Teamwork Desk

Try it

Create Customer with Teamwork Desk API on New Submission from Typeform API

Typeform + Teamwork Desk

Try it

Create Customer with Teamwork Desk API on New Submission (Instant) from Jotform API

Jotform + Teamwork Desk

Try it

Create Customer with Teamwork Desk API on New Custom Webhook Events from Stripe API

Stripe + Teamwork Desk

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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

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: