Create Payee with OnlineCheckWriter API on New Email Open from Campaign Monitor API

Pipedream makes it easy to connect APIs for OnlineCheckWriter, Campaign Monitor and 2,900+ other apps remarkably fast.

Trigger workflow on

New Email Open from the Campaign Monitor API

Next, do this

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

Select this integration
Configure the New Email Open trigger
1. Connect your Campaign Monitor account
2. Configure timer
3. Select a Client ID
4. Select a Campaign ID
Configure the Create Payee action
1. Connect your OnlineCheckWriter account
2. Configure Name
3. Optional- Configure Company
4. Optional- Configure Email
5. Optional- Configure Phone
6. Optional- Configure Address 1
7. Optional- Configure Address 2
8. Optional- Configure Country
9. Optional- Configure State
10. Optional- Configure City
11. Optional- Configure Zip
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 Email Open on Campaign Monitor

Description:Emit new event when an email from a campaign is opened

Version:0.0.1

Key:campaign_monitor-new-email-open

View on GitHub

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "campaign_monitor-new-email-open",
  name: "New Email Open",
  description: "Emit new event when an email from a campaign is opened",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    campaignId: {
      propDefinition: [
        common.props.campaignMonitor,
        "campaignId",
        (c) => ({
          clientId: c.clientId,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.campaignMonitor.listOpens;
    },
    getArgs() {
      return {
        campaignId: this.campaignId,
        params: {
          orderfield: "date",
          orderdirection: "desc",
        },
      };
    },
    generateMeta(open) {
      const ts = Date.parse(open[this.getTsField()]);
      return {
        id: `${open.EmailAddress}-${ts}`,
        summary: `New Email Open: ${open.EmailAddress}`,
        ts,
      };
    },
  },
};

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
Campaign Monitor	`campaignMonitor`	`app`	This component uses the Campaign Monitor app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Client ID	`clientId`	`string`	Select a value from the drop down menu.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

ViewReportsManageListsImportSubscribersViewTransactionalSendTransactionalAdministerAccount

About Campaign Monitor#

Email Marketing Platform & Services

Action#

Create Payee on OnlineCheckWriter

Description:Registers a new payee within the system.[See the documentation](https://apiv3.onlinecheckwriter.com/#38a31300-bf13-4da1-ac97-dd81525b57b3)

Version:0.0.2

Key:onlinecheckwriter-create-payee

View on GitHub

Action Code#

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

export default {
  key: "onlinecheckwriter-create-payee",
  name: "Create Payee",
  description: "Registers a new payee within the system.[See the documentation](https://apiv3.onlinecheckwriter.com/#38a31300-bf13-4da1-ac97-dd81525b57b3)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the payee.",
    },
    company: {
      type: "string",
      label: "Company",
      description: "The company of the payee.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the payee.",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The phone number of the payee.",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address 1",
      description: "The first line of the address of the payee.",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address 2",
      description: "The second line of the address of the payee.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "The country of the payee.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "The state of the payee.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The city of the payee.",
      optional: true,
    },
    zip: {
      type: "string",
      label: "Zip",
      description: "The zip code of the payee.",
      optional: true,
    },
  },
  methods: {
    createPayees(args = {}) {
      return this.app.post({
        path: "/payees",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createPayees,
      name,
      company,
      email,
      phone,
      address1,
      address2,
      country,
      state,
      city,
      zip,
    } = this;

    const response = await createPayees({
      $,
      data: {
        payees: [
          {
            name,
            company,
            email,
            phone,
            address1,
            address2,
            country,
            state,
            city,
            zip,
          },
        ],
      },
    });

    $.export("$summary", `Successfully created payee with ID \`${response.data.payees[0].payeeId}\`.`);
    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
OnlineCheckWriter	`app`	`app`	This component uses the OnlineCheckWriter app.
Name	`name`	`string`	The name of the payee.
Company	`company`	`string`	The company of the payee.
Email	`email`	`string`	The email of the payee.
Phone	`phone`	`string`	The phone number of the payee.
Address 1	`address1`	`string`	The first line of the address of the payee.
Address 2	`address2`	`string`	The second line of the address of the payee.
Country	`country`	`string`	The country of the payee.
State	`state`	`string`	The state of the payee.
City	`city`	`string`	The city of the payee.
Zip	`zip`	`string`	The zip code of the payee.