Add Customers to Segment with Customer.io API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Add Customers to Segment with the Customer.io API

No credit card required

▶

Watch us build a workflow

8 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 Customer.io action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Add Customers to Segment action
1. Connect your Customer.io account
2. Configure Customer ID
3. Configure Segment ID
4. Optional- Select a Id Type
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#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

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: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

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#

Add Customers to Segment on Customer.io

Description:Add people to a manual segment by ID. You are limited to 1000 customer IDs per request. [See the docs here](https://www.customer.io/docs/api/#operation/add_to_segment)

Version:0.0.1

Key:customer_io-add-customers-to-segment

View on GitHub

Customer.io Overview#

Customer.io is a versatile automation tool that allows you to harness the power of email, SMS, and push notifications to create personalized customer experiences. With its comprehensive API, Customer.io enables you to track customer interactions, segment audiences, and trigger targeted communications based on user behavior and data. By leveraging Pipedream, you can easily connect Customer.io to various other services and APIs to automate complex workflows, synthesize data, and respond to events in real-time.

Action Code#

import app from "../../customer_io.app.mjs";
import options from "../../common/options.mjs";

export default {
  key: "customer_io-add-customers-to-segment",
  name: "Add Customers to Segment",
  description: "Add people to a manual segment by ID. You are limited to 1000 customer IDs per request. [See the docs here](https://www.customer.io/docs/api/#operation/add_to_segment)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    customerIds: {
      propDefinition: [
        app,
        "customerId",
      ],
      type: "string[]",
      description: "The customer IDs you want to add to the segment.",
    },
    segmentId: {
      type: "string",
      label: "Segment ID",
      description: "The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage.",
    },
    idType: {
      label: "Id Type",
      type: "string",
      description: "The type of ids you want to use. All of the values in the `ids` array must be of this type. If you don't provide this parameter, we assume that the `ids` array contains `id` values.",
      options: options.ID_TYPES,
      optional: true,
    },
  },
  async run({ $ }) {
    await this.app.addCustomersToSegment(
      this.segmentId,
      this.customerIds,
      this.idType,
      $,
    );
    $.export("$summary", "Successfully added customers to segment");
  },
};

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
Customer.io	`app`	`app`	This component uses the Customer.io app.
Customer ID	`customerIds`	`string[]`	The customer IDs you want to add to the segment.
Segment ID	`segmentId`	`string`	The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage.
Id Type	`idType`	`string`	Select a value from the drop down menu:`idemailcio_id`

Action Authentication#

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

To connect your Customer.io account to Pipedream, sign in to your Customer.io account and navigate to Data & Integrations > Integrations > API, then copy your site_id and api_key fields and paste them below.