Create Mail Check with OnlineCheckWriter API on New Scheduled Tasks from AWS API

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

Trigger workflow on

New Scheduled Tasks from the AWS API

Next, do this

Create Mail Check 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 AWS 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 Scheduled Tasks trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Configure Secret
Configure the Create Mail Check action
1. Connect your OnlineCheckWriter account
2. Optional- Configure Shipping To Custom Address?
3. Optional- Select a Custom From Address ID
4. Optional- Select a Custom To Address ID
5. Optional- Select a Custom Shipping Type ID
6. Select a Check ID
7. Select a Shipping Type ID
8. Select a Paper Type ID
9. Optional- Select a Inform Type ID
10. Optional- Configure Enable SMS Inform
11. Optional- Configure Enable Email Inform
12. Optional- Configure Payee Email
13. Optional- Configure Payee Phone
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 Scheduled Tasks on AWS

Description:Creates a Step Function State Machine to publish a message to an SNS topic at a specific timestamp. The SNS topic delivers the message to this Pipedream source, and the source emits it as a new event.

Version:0.4.2

Key:aws-new-scheduled-tasks

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import base from "../common/scheduled.mjs";
import { toSingleLineString } from "../../common/utils.mjs";

export default {
  ...base,
  key: "aws-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  description: toSingleLineString(`
    Creates a Step Function State Machine to publish a message
    to an SNS topic at a specific timestamp. The SNS topic delivers
    the message to this Pipedream source, and the source emits it as a new event.
  `),
  version: "0.4.2",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  methods: {
    ...base.methods,
    getStateMachineDefinition() {
      const { PD_COMPONENT: componentId } = process.env;
      const topicArn = this.getTopicArn();
      return {
        Comment: `Task Scheduler for Pipedream component ${componentId}`,
        StartAt: "Wait",
        States: {
          Wait: {
            Comment: "Wait until specified timestamp",
            Type: "Wait",
            TimestampPath: "$.timestamp",
            Next: "SendMessageToSNS",
          },
          SendMessageToSNS: {
            Type: "Task",
            Resource: "arn:aws:states:::sns:publish",
            Parameters: {
              "TopicArn": topicArn,
              "Message.$": "$",
            },
            End: true,
          },
        },
      };
    },
    getStateMachinePermissions() {
      const topicArn = this.getTopicArn();
      const document = {
        Version: "2012-10-17",
        Statement: [
          {
            Effect: "Allow",
            Action: [
              "sns:Publish",
            ],
            Resource: [
              topicArn,
            ],
          },
        ],
      };
      const name = "publish-messages-to-pipedream-sns-topic";
      return {
        document,
        name,
      };
    },
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
AWS Region	`region`	`string`	Select a value from the drop down menu.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `secret` parameter of each HTTP POST request

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Create Mail Check on OnlineCheckWriter

Description:Creates a mail check. [See the documentation](https://apiv3.onlinecheckwriter.com/#f4562b65-70e8-4c4d-8444-8898e61ab7f0).

Version:0.0.1

Key:onlinecheckwriter-create-mail-check

View on GitHub

Action Code#

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

export default {
  key: "onlinecheckwriter-create-mail-check",
  name: "Create Mail Check",
  description: "Creates a mail check. [See the documentation](https://apiv3.onlinecheckwriter.com/#f4562b65-70e8-4c4d-8444-8898e61ab7f0).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    isShippingToCustomAddress: {
      type: "boolean",
      label: "Shipping To Custom Address?",
      description: "Value is `true` if sending mail to custom address. Default `false`",
      optional: true,
    },
    customFromAddressId: {
      description: "Must be a custom from address ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "customFromAddressId",
      ],
    },
    customToAddressId: {
      description: "Must be a custom to address ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "customToAddressId",
      ],
    },
    customShippingTypeId: {
      label: "Custom Shipping Type ID",
      description: "Must be a valid custom shipping type ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    checkId: {
      propDefinition: [
        app,
        "checkId",
      ],
    },
    shippingTypeId: {
      optional: false,
      description: "The shipping type ID of the check.",
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    paperTypeId: {
      propDefinition: [
        app,
        "paperTypeId",
      ],
    },
    informTypeId: {
      propDefinition: [
        app,
        "informTypeId",
      ],
    },
    enableSmsInform: {
      propDefinition: [
        app,
        "enableSmsInform",
      ],
    },
    enableEmailInform: {
      type: "boolean",
      label: "Enable Email Inform",
      description: "Value is `true` if email inform is enabled. Default `false`.",
      optional: true,
    },
    payeeEmail: {
      description: "Required if **Enable Email Inform** is `true` and there is no email on the associated payee.",
      propDefinition: [
        app,
        "payeeEmail",
      ],
    },
    payeePhone: {
      description: "Required if **Enable SMS Inform** is `true` and there is no phone on the associated payee.",
      propDefinition: [
        app,
        "payeePhone",
      ],
    },
  },
  methods: {
    createMailChecks(args = {}) {
      return this.app.post({
        path: "/mailchecks",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createMailChecks,
      isShippingToCustomAddress,
      customFromAddressId,
      customToAddressId,
      customShippingTypeId,
      checkId,
      shippingTypeId,
      paperTypeId,
      informTypeId,
      enableSmsInform,
      enableEmailInform,
      payeeEmail,
      payeePhone,
    } = this;

    const response = await createMailChecks({
      $,
      data: {
        isShippingToCustomAddress,
        customFromAddressId,
        customToAddressId,
        customShippingTypeId,
        mailChecks: [
          {
            checkId,
            shippingTypeId,
            paperTypeId,
            informTypeId,
            ...(enableSmsInform !== undefined && {
              enableSmsInform: +enableSmsInform,
            }),
            ...(enableEmailInform !== undefined && {
              enableEmailInform: +enableEmailInform,
            }),
            payeeEmail,
            payeePhone,
          },
        ],
      },
    });
    $.export("$summary", "Successfully created and mailed checks.");
    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.
Shipping To Custom Address?	`isShippingToCustomAddress`	`boolean`	Value is `true` if sending mail to custom address. Default `false`
Custom From Address ID	`customFromAddressId`	`string`	Select a value from the drop down menu.
Custom To Address ID	`customToAddressId`	`string`	Select a value from the drop down menu.
Custom Shipping Type ID	`customShippingTypeId`	`string`	Select a value from the drop down menu:`{ "label": "First Class", "value": "1" }{ "label": "First Class with Tracking", "value": "3" }{ "label": "Priority Mail", "value": "4" }{ "label": "Express Mail", "value": "5" }{ "label": "Standard Overnight -Fedex-By 3pm the next business day", "value": "12" }{ "label": "Fedex Saturday Delivery", "value": "20" }`
Check ID	`checkId`	`string`	Select a value from the drop down menu.
Shipping Type ID	`shippingTypeId`	`string`	Select a value from the drop down menu:`{ "label": "First Class", "value": "1" }{ "label": "First Class with Tracking", "value": "3" }{ "label": "Priority Mail", "value": "4" }{ "label": "Express Mail", "value": "5" }{ "label": "Standard Overnight -Fedex-By 3pm the next business day", "value": "12" }{ "label": "Fedex Saturday Delivery", "value": "20" }`
Paper Type ID	`paperTypeId`	`string`	Select a value from the drop down menu:`{ "label": "Regular Check Paper", "value": "7" }{ "label": "Hollogram Check Paper", "value": "8" }{ "label": "Ultra Hollogram Check Paper", "value": "9" }`
Inform Type ID	`informTypeId`	`string`	Select a value from the drop down menu:`{ "label": "Notify Receiver by Sms", "value": "10" }`
Enable SMS Inform	`enableSmsInform`	`boolean`	Value is `true` if SMS inform is enabled. Default `false`
Enable Email Inform	`enableEmailInform`	`boolean`	Value is `true` if email inform is enabled. Default `false`.
Payee Email	`payeeEmail`	`string`	Required if Enable Email Inform is `true` and there is no email on the associated payee.
Payee Phone	`payeePhone`	`string`	Required if Enable SMS Inform is `true` and there is no phone on the associated payee.

Action Authentication#

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

About OnlineCheckWriter#

Online Check Writer: Online Check Printing, eChecks, Mail Checks

More Ways to Connect OnlineCheckWriter + AWS#

Other Popular Integrations#

Create Check with OnlineCheckWriter API on New DynamoDB Stream Event from AWS API

AWS + OnlineCheckWriter

Create Mail Check with OnlineCheckWriter API on New Scheduled Tasks from AWS API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular