Create Or Update Contact with Gist API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Or Update Contact with the Gist API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Gist 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 Or Update Contact action
1. Connect your Gist account
2. Optional- Configure Email
3. Optional- Select a User Id
4. Optional- Configure Name
5. Optional- Configure Phone
6. Optional- Configure Signed Up At
7. Optional- Configure Last Seen Ip
8. Optional- Configure Last Seen User Agent
9. Optional- Configure Custom Properties
10. Optional- Configure Unsubscribed From Emails
11. Optional- Select one or more Tag
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 Or Update Contact on Gist

Description:Create or update a contact in Gist [See docs](https://developers.getgist.com/api/#create-or-update-a-contact)

Version:0.0.1

Key:gist-create-or-update-contact

View on GitHub

Gist Overview#

The Gist API empowers you to automate interactions with your Gist CRM platform, efficiently managing contacts, tags, and conversations. Tapping into this potential with Pipedream allows you to build seamless automation workflows that sync data between Gist and other services, trigger actions based on customer behavior, and keep your sales and support teams aligned with real-time information.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import gist from "../../gist.app.mjs";

export default {
  key: "gist-create-or-update-contact",
  name: "Create Or Update Contact",
  description: "Create or update a contact in Gist [See docs](https://developers.getgist.com/api/#create-or-update-a-contact)",
  type: "action",
  version: "0.0.1",
  props: {
    gist,
    email: {
      propDefinition: [
        gist,
        "email",
      ],
      optional: true,
    },
    userId: {
      propDefinition: [
        gist,
        "userId",
      ],
      optional: true,
    },
    name: {
      label: "Name",
      description: "The full name of the contact",
      type: "string",
      optional: true,
    },
    phone: {
      label: "Phone",
      description: "The contact number of the contact",
      type: "string",
      optional: true,
    },
    signedUpAt: {
      label: "Signed Up At",
      description: "The time the contact signed up",
      type: "string",
      optional: true,
    },
    lastSeenIp: {
      label: "Last Seen Ip",
      description: "The last IP address the contact visited your website from",
      type: "string",
      optional: true,
    },
    lastSeenUserAgent: {
      label: "Last Seen User Agent",
      description: "The last contact agent the contact was seen using",
      type: "string",
      optional: true,
    },
    customProperties: {
      label: "Custom  Properties",
      description: "A JSON object containing the contact's custom properties. E.g. { \"name\": \"John Doe\" }",
      type: "object",
      optional: true,
    },
    unsubscribedFromEmails: {
      label: "Unsubscribed From Emails",
      description: "If the contact has unsubscribed from emails or not",
      type: "boolean",
      optional: true,
    },
    tagId: {
      propDefinition: [
        gist,
        "tagId",
      ],
      type: "string[]",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      userId,
      signedUpAt,
      lastSeenIp,
      lastSeenUserAgent,
      customProperties,
      unsubscribedFromEmails,
      tagId,
      ...data
    } = this;

    if (!userId && !this.email) {
      throw new ConfigurationError("You must fill in at least **User Id** or **Email**");
    }

    const response = await this.gist.createOrUpdateContact({
      $,
      data: {
        id: userId,
        signed_up_at: signedUpAt,
        last_seen_ip: lastSeenIp,
        last_seen_user_agent: lastSeenUserAgent,
        custom_properties: customProperties,
        unsubscribed_from_emails: unsubscribedFromEmails,
        tags: tagId && tagId.map((tag) => tag.label),
        ...data,
      },
    });

    const action = (response.contact?.created_at != response.contact?.updated_at)
      ? "updated"
      : "created";

    $.export("$summary", `Successfully ${action} ${this.name || this.email} contact`);

    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
Gist	`gist`	`app`	This component uses the Gist app.
Email	`email`	`string`	The contact's email address. Required on create. Required if no user_id is supplied on update.
User Id	`userId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The full name of the contact
Phone	`phone`	`string`	The contact number of the contact
Signed Up At	`signedUpAt`	`string`	The time the contact signed up
Last Seen Ip	`lastSeenIp`	`string`	The last IP address the contact visited your website from
Last Seen User Agent	`lastSeenUserAgent`	`string`	The last contact agent the contact was seen using
Custom Properties	`customProperties`	`object`	A JSON object containing the contact's custom properties. E.g. { "name": "John Doe" }
Unsubscribed From Emails	`unsubscribedFromEmails`	`boolean`	If the contact has unsubscribed from emails or not
Tag	`tagId`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

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

read_contactwrite_contactread_bulk_contactswrite_bulk_contactsread_conversationswrite_conversationsread_eventsread_tagswrite_tagsread_teamsread_teammates