Create Contact with Nutshell API on New Query Results from Snowflake API

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

Trigger workflow on

New Query Results from the Snowflake 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 Snowflake 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 New Query Results trigger
1. Connect your Snowflake account
2. Configure timer
3. Configure SQL Query
4. Optional- Configure Primary key
5. Optional- Configure Emit individual events
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#

New Query Results on Snowflake

Description:Run a SQL query on a schedule, triggering a workflow for each row of results

Version:0.2.3

Key:snowflake-query-results

View on GitHub

Snowflake Overview#

Snowflake offers a cloud database and related tools to help developers create robust, secure, and scalable data warehouses. See Snowflake's Key Concepts & Architecture

Getting Started

1. Create a user, role and warehouse in Snowflake

Snowflake recommends you create a new user, role, and warehouse when you integrate a third-party tool like Pipedream. This way, you can control permissions via the user / role, and separate Pipedream compute and costs with the warehouse. You can do this directly in the Snowflake UI

We recommend you create a read-only account if you only need to query Snowflake. If you need to insert data into Snowflake, add permissions on the appropriate objects after you create your user.

2. Enter those details in Pipedream

Visit https://pipedream.com/accounts. Click the button to Connect an App. Enter the required Snowflake account data.

You'll only need to connect your account once in Pipedream. You can connect this account to multiple workflows to run queries against Snowflake, insert data, and more.

3. Build your first workflow

Visit https://pipedream.com/new to build your first workflow. Pipedream workflows let you connect Snowflake with 1,000+ other apps. You can trigger workflows on Snowflake queries, sending results to Slack, Google Sheets, or any app that exposes an API. Or you can accept data from another app, transform it with Python, Node.js, Go or Bash code, and insert it into Snowflake.

Learn more at Pipedream University

Trigger Code#

import common from "../common.mjs";
import { v4 as uuidv4 } from "uuid";

export default {
  ...common,
  type: "source",
  key: "snowflake-query-results",
  name: "New Query Results",
  // eslint-disable-next-line
  description: "Run a SQL query on a schedule, triggering a workflow for each row of results",
  version: "0.2.3",
  props: {
    ...common.props,
    sqlQuery: {
      type: "string",
      label: "SQL Query",
      description: "Run this query on a schedule, triggering the workflow for each row of results",
    },
    // Ordering props correctly
    timer: common.props.timer,
    dedupeKey: {
      type: "string",
      label: "Primary key",
      description: "The column in your query to use for de-duplication. Duplicate rows won't trigger your workflow",
      optional: true,
    },
    emitIndividualEvents: {
      propDefinition: [
        common.props.snowflake,
        "emitIndividualEvents",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(data) {
      const {
        row: { [this.dedupeKey]: id = uuidv4() },
        timestamp: ts,
      } = data;
      const summary = `New event (ID: ${id})`;
      return {
        id,
        summary,
        ts,
      };
    },
    generateMetaForCollection(data) {
      const { timestamp: ts } = data;
      const id = uuidv4();
      const summary = `New event (ID: ${id})`;
      return {
        id,
        summary,
        ts,
      };
    },
    getStatement() {
      return {
        sqlText: this.sqlQuery,
      };
    },
  },
};

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
Snowflake	`snowflake`	`app`	This component uses the Snowflake app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	Watch for changes on this schedule
SQL Query	`sqlQuery`	`string`	Run this query on a schedule, triggering the workflow for each row of results
Primary key	`dedupeKey`	`string`	The column in your query to use for de-duplication. Duplicate rows won't trigger your workflow
Emit individual events	`emitIndividualEvents`	`boolean`	Defaults to `true`, triggering workflows on each record in the result set. Set to `false` to emit records in batch (advanced)

Trigger Authentication#

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

We recommend you create a read-only account if you only need to query Snowflake. If you need to insert data into Snowflake, add permissions on the appropriate objects after you create your user.

About Snowflake#

A data warehouse built for the cloud

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

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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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: