Get Contact with Campayn API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Get Contact with the Campayn 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 Campayn 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 Get Contact action
1. Connect your Campayn account
2. Select a List
3. Select a Contact
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#

Get Contact on Campayn

Description:Retrieves an existing contact. [See the docs](https://github.com/nebojsac/Campayn-API/blob/master/endpoints/contacts.md#get-a-contact)

Version:0.0.1

Key:campayn-get-contact

View on GitHub

Campayn Overview#

The Campayn API lets you automate email marketing tasks directly within Pipedream. It provides programmatic access to manage contacts, lists, and email campaigns. With Pipedream, you can build serverless workflows to integrate Campayn with other apps and services, triggering actions based on events, scheduling regular email campaigns, or syncing data across platforms.

Action Code#

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

export default {
  key: "campayn-get-contact",
  name: "Get Contact",
  description: "Retrieves an existing contact. [See the docs](https://github.com/nebojsac/Campayn-API/blob/master/endpoints/contacts.md#get-a-contact)",
  version: "0.0.1",
  type: "action",
  props: {
    campayn,
    listId: {
      propDefinition: [
        campayn,
        "listId",
      ],
    },
    contactId: {
      propDefinition: [
        campayn,
        "contactId",
        (c) => ({
          listId: c.listId,
        }),
      ],
    },
  },
  async run({ $ }) {

    const response = await this.campayn.getContact(this.contactId, {
      $,
    });

    $.export("$summary", `Successfully retrieved contact with ID ${this.contactId}.`);

    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
Campayn	`campayn`	`app`	This component uses the Campayn app.
List	`listId`	`string`	Select a value from the drop down menu.
Contact	`contactId`	`string`	Select a value from the drop down menu.