Create a New Recipient with Stannp API on New Render Completed from MoDeck API

Pipedream makes it easy to connect APIs for Stannp, MoDeck and 2,000+ other apps remarkably fast.

Trigger workflow on

New Render Completed from the MoDeck API

Next, do this

Create a New Recipient with the Stannp 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 MoDeck trigger and Stannp action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Render Completed trigger
1. Connect your MoDeck account
2. Configure Polling interval
3. Select a Deck Name
Configure the Create a New Recipient action
1. Connect your Stannp account
2. Optional- Select a Group ID
3. Optional- Configure First Name
4. Optional- Configure Last Name
5. Optional- Configure Address Line 1
6. Optional- Configure Address Line 2
7. Optional- Configure Address Line 3
8. Optional- Configure City
9. Optional- Configure Postal Code
10. Optional- Configure Country
11. Optional- Configure Email Address
12. Optional- Configure Phone Number
13. Optional- Configure Reference ID
14. Optional- Select a On Duplicate
15. Optional- Configure Custom Fields
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 Render Completed on MoDeck

Description:Emit new event when a render is completed.

Version:0.0.1

Key:modeck-render-complete

View on GitHub

MoDeck Overview#

The MoDeck API offers an interface for managing playlists and videos within their platform, providing endpoints for various operations like retrieving video details, updating playlists, or managing users. Integrating MoDeck with Pipedream allows you to automate interactions with your MoDeck data, such as syncing playlists, updating video statuses, or triggering actions based on video analytics. With Pipedream's serverless platform, you can build powerful workflows that react to events in real-time, schedule tasks, and connect MoDeck with hundreds of other services.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import modeck from "../../modeck.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "modeck-render-complete",
  name: "New Render Completed",
  version: "0.0.1",
  description: "Emit new event when a render is completed.",
  type: "source",
  dedupe: "unique",
  props: {
    modeck,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the MoDeck on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    deck: {
      propDefinition: [
        modeck,
        "deck",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || 0;
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent(maxResults = 0) {
      const {
        modeck,
        deck,
      } = this;

      const lastDate = this._getLastDate();

      const { renderList } = await modeck.listRenders({
        data: {
          deck,
        },
      });

      let responseArray = [];
      let count = 0;

      for (const render of renderList) {
        if (new Date(render.data) <= new Date(lastDate)) break;
        responseArray.push(render);
        if (maxResults && (++count === maxResults)) break;
      }
      if (responseArray.length) this._setLastDate(responseArray[0].date);

      for (const render of responseArray.reverse()) {
        this.$emit(
          render,
          {
            id: render.id,
            summary: `The render with id: "${render.id}" has been completed!`,
            ts: render.date,
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
MoDeck	`modeck`	`app`	This component uses the MoDeck app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the MoDeck on this schedule
Deck Name	`deck`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About MoDeck#

Create video templates in After Effects, make them editable online by anyone. You control the creative, let your team control the content.

Action#

Create a New Recipient on Stannp

Description:Creates a new recipient in a specified group. [See the Stannp documentation](https://www.stannp.com/us/direct-mail-api/recipients)

Version:0.0.1

Key:stannp-create-recipient

View on GitHub

Stannp Overview#

The Stannp API integrates with Pipedream to automate direct mail campaigns. You can create, manage, and send personalized postcards, letters, or flyers using Stannp's services. With Pipedream's serverless platform, you can connect Stannp to various triggers and actions, creating workflows that handle everything from customer outreach to event-triggered mailings. This combination is powerful for businesses looking to blend digital and physical marketing strategies seamlessly.

Action Code#

import { ON_DUPLICATE_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import stannp from "../../stannp.app.mjs";

export default {
  key: "stannp-create-recipient",
  name: "Create a New Recipient",
  description: "Creates a new recipient in a specified group. [See the Stannp documentation](https://www.stannp.com/us/direct-mail-api/recipients)",
  version: "0.0.1",
  type: "action",
  props: {
    stannp,
    groupId: {
      propDefinition: [
        stannp,
        "groupId",
      ],
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the recipient.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the recipient.",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address Line 1",
      description: "The first line of the address.",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address Line 2",
      description: "The second line of the address.",
      optional: true,
    },
    address3: {
      type: "string",
      label: "Address Line 3",
      description: "The third line of the address.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The city of the address.",
      optional: true,
    },
    postcode: {
      type: "string",
      label: "Postal Code",
      description: "The postal code of the address.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "The ISO 3166-1 Alpha 2 Country Code (e.g., GB, US, FR).",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email Address",
      description: "The email address of the recipient.",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "The phone number of the recipient.",
      optional: true,
    },
    refId: {
      type: "string",
      label: "Reference ID",
      description: "An alternative ID to associate the recipient with an ID in another service.",
      optional: true,
    },
    onDuplicate: {
      type: "string",
      label: "On Duplicate",
      description: "What to do if a duplicate recipient is found (update/ignore/duplicate).",
      options: ON_DUPLICATE_OPTIONS,
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "Additional fields to the recipient.",
      optional: true,
    },
  },
  async run({ $ }) {
    const parsedCustomFields = this.customFields
      ? parseObject(this.customFields)
      : {};

    const response = await this.stannp.createRecipient({
      $,
      data: {
        firstname: this.firstName,
        lastname: this.lastName,
        address1: this.address1,
        address2: this.address2,
        address3: this.address3,
        city: this.city,
        postcode: this.postcode,
        country: this.country,
        email: this.email,
        phone_number: this.phoneNumber,
        ref_id: this.refId,
        groupId: this.groupId,
        on_duplicate: this.onDuplicate,
        ...parsedCustomFields,
      },
    });

    $.export("$summary", `Successfully created recipient with ID: ${response.data?.id}`);
    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
Stannp	`stannp`	`app`	This component uses the Stannp app.
Group ID	`groupId`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	The first name of the recipient.
Last Name	`lastName`	`string`	The last name of the recipient.
Address Line 1	`address1`	`string`	The first line of the address.
Address Line 2	`address2`	`string`	The second line of the address.
Address Line 3	`address3`	`string`	The third line of the address.
City	`city`	`string`	The city of the address.
Postal Code	`postcode`	`string`	The postal code of the address.
Country	`country`	`string`	The ISO 3166-1 Alpha 2 Country Code (e.g., GB, US, FR).
Email Address	`email`	`string`	The email address of the recipient.
Phone Number	`phoneNumber`	`string`	The phone number of the recipient.
Reference ID	`refId`	`string`	An alternative ID to associate the recipient with an ID in another service.
On Duplicate	`onDuplicate`	`string`	Select a value from the drop down menu:`updateignoreduplicate`
Custom Fields	`customFields`	`object`	Additional fields to the recipient.

Action Authentication#

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

To retrieve your API Key,