Create Contact with Nutshell API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Nutshell, Schedule and 2,400+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

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

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Contact action
1. Connect your Nutshell account
2. Optional- Configure Name
3. Optional- Configure Phones
4. Configure Email
5. Optional- Configure Address
6. Optional- Select one or more Account Id
7. Optional- Select one or more Lead Id
8. Optional- Select a Territory Id
9. Optional- Select one or more Audience Id
10. Configure Description
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Contact on Nutshell

Description:Creates a new contact. [See the documentation](https://developers.nutshell.com/detail/class_core.html#a4b40d4fe9c7b8ddfd7231aca65cd1556)

Version:0.0.1

Key:nutshell-create-contact

View on GitHub

Nutshell Overview#

The Nutshell API allows you to access and manage data within the Nutshell CRM platform, enabling you to automate tasks, sync information across apps, and build custom integrations. With Pipedream, these capabilities are harnessed through serverless workflows that can trigger actions within Nutshell or react to events, all with minimal setup. You can create leads, update contacts, manage sales processes, and more, all in a scalable and efficient manner.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import nutshell from "../../nutshell.app.mjs";

export default {
  key: "nutshell-create-contact",
  name: "Create Contact",
  description: "Creates a new contact. [See the documentation](https://developers.nutshell.com/detail/class_core.html#a4b40d4fe9c7b8ddfd7231aca65cd1556)",
  version: "0.0.1",
  type: "action",
  props: {
    nutshell,
    name: {
      type: "string",
      label: "Name",
      description: "The name to the contact.",
      optional: true,
    },
    phone: {
      propDefinition: [
        nutshell,
        "phone",
      ],
      description: "The phone numbers of the contact.",
    },
    email: {
      propDefinition: [
        nutshell,
        "email",
      ],
      description: "The email address of the contact.",
    },
    address: {
      propDefinition: [
        nutshell,
        "address",
      ],
      optional: true,
    },
    accountId: {
      propDefinition: [
        nutshell,
        "accountId",
      ],
      type: "string[]",
      description: "The account's Id to the Contact.",
      optional: true,
    },
    leadId: {
      propDefinition: [
        nutshell,
        "leadId",
        ({ accountId }) => ({
          accountId,
        }),
      ],
      optional: true,
    },
    territoryId: {
      propDefinition: [
        nutshell,
        "territoryId",
      ],
      description: "The territory of the contact.",
      optional: true,
    },
    audienceId: {
      propDefinition: [
        nutshell,
        "audienceId",
      ],
      optional: true,
    },
    description: {
      propDefinition: [
        nutshell,
        "description",
      ],
      description: "A description to identify the new contact.",
      reloadProps: true,
    },
  },
  async additionalProps() {
    const { result: { Contacts: fields } } = await this.getCustomFields();
    const props = {};
    let i = 0;
    for (const field of fields) {
      i++;
      props[`customField_${i}`] = {
        type: "string",
        label: field.name,
        description: `Custom field ${i}.`,
        optional: true,
      };
    }
    return props;
  },
  methods: {
    async getCustomFields() {
      return await this.nutshell.post({
        method: "findCustomFields",
      });
    },
    async parseCustomFields(props) {
      const customFields = {};
      const { result: { Contacts } } = await this.getCustomFields();

      let i = 0;
      for (const field of Contacts) {
        i++;
        if (props[`customField_${i}`]) {
          customFields[field.name] = props[`customField_${i}`];
        }
      }
      return customFields;
    },
  },
  async run({ $ }) {
    const customFields = await this.parseCustomFields(this);
    const response = await this.nutshell.post({
      $,
      method: "newContact",
      data: {
        params: {
          contact: {
            name: this.name,
            description: this.description,
            phone: this.phone && parseObject(this.phone),
            email: this.email && parseObject(this.email),
            address: this.address && parseObject(this.address),
            leads: this.leadId && this.leadId.map((lead) => ({
              id: lead,
            })),
            accounts: this.accountId && this.accountId.map((account) => ({
              id: account,
            })),
            territoryId: this.territoryId,
            audienceId: this.audienceId && this.audienceId.map((audience) => ({
              id: audience,
            })),
            customFields,
          },
        },
      },
    });

    $.export("$summary", `New contact created with Id: ${response.result?.id}`);
    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
Nutshell	`nutshell`	`app`	This component uses the Nutshell app.
Name	`name`	`string`	The name to the contact.
Phones	`phone`	`string[]`	The phone numbers of the contact.
Email	`email`	`string[]`	The email address of the contact.
Address	`address`	`string[]`	A list of address objects. E.g. `{"address_1":"100 Second St.","address_2":"Apt. 4","address_3":"c/o Barclay Fowler","city":"Ann Arbor","state":"MI","postalCode": "48103","country": "US"}`
Account Id	`accountId`	`string[]`	Select a value from the drop down menu.
Lead Id	`leadId`	`string[]`	Select a value from the drop down menu.
Territory Id	`territoryId`	`string`	Select a value from the drop down menu.
Audience Id	`audienceId`	`string[]`	Select a value from the drop down menu.
Description	`description`	`string`	A description to identify the new contact.

Action Authentication#

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

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