Create Mail Check with OnlineCheckWriter API on New Action Performed from PostHog API

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

Trigger workflow on

New Action Performed from the PostHog 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 PostHog 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 Action Performed trigger
1. Connect your PostHog account
2. Configure timer
3. Select a Organization ID
4. Select a Project ID
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 Action Performed on PostHog

Description:Emit new event when an action is performed in a project. [See the documentation](https://posthog.com/docs/api/query#post-api-projects-project_id-query)

Version:0.0.2

Key:posthog-new-action-performed

View on GitHub

PostHog Overview#

The PostHog API lets you track events, update user properties, and extract analytics to understand user behavior within your applications. Integrating this API into Pipedream workflows allows you to automate actions based on event data, sync user properties across platforms, and trigger alerts or notifications.

Trigger Code#

import posthog from "../../posthog.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "posthog-new-action-performed",
  name: "New Action Performed",
  description: "Emit new event when an action is performed in a project. [See the documentation](https://posthog.com/docs/api/query#post-api-projects-project_id-query)",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    posthog,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    organizationId: {
      propDefinition: [
        posthog,
        "organizationId",
      ],
    },
    projectId: {
      propDefinition: [
        posthog,
        "projectId",
        (c) => ({
          organizationId: c.organizationId,
        }),
      ],
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    emitEvent(event) {
      const meta = this.generateMeta(event);
      this.$emit(event, meta);
    },
    generateMeta(event) {
      return {
        id: event.uuid,
        summary: `New ${event.event} event`,
        ts: Date.parse(event.timestamp),
      };
    },
    buildQuery(limit) {
      const lastTs = this._getLastTs();
      let query = "SELECT * FROM events";
      if (lastTs) {
        query += ` WHERE timestamp > '${lastTs}'`;
      }
      query += " ORDER BY timestamp DESC";
      if (limit) {
        query += ` LIMIT ${limit}`;
      }
      return query;
    },
    formatEvents(columns, results) {
      return results.map((result) => {
        const values = {};
        for (let i = 0; i < columns.length; i++) {
          values[columns[i]] = result[i];
        }
        return values;
      });
    },
    async processEvent(limit) {
      const {
        columns, results,
      } = await this.posthog.createQuery({
        projectId: this.projectId,
        data: {
          query: {
            kind: "HogQLQuery",
            query: this.buildQuery(limit),
          },
        },
      });
      const events = this.formatEvents(columns, results);
      if (!events?.length) {
        return;
      }
      this._setLastTs(events[0].timestamp.slice(0, 19));
      events.reverse().forEach((event) => this.emitEvent(event));
    },
  },
  async run() {
    await this.processEvent();
  },
};

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
PostHog	`posthog`	`app`	This component uses the PostHog app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Organization ID	`organizationId`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About PostHog#

Product Analytics? Session Recording? Feature Flags? Experiments? PostHog does that. Open source, backed by @ycombinator

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.