Add Data Store Record with NiftyImages API on New Delivery from Thanks.io API

Pipedream makes it easy to connect APIs for NiftyImages, Thanks.io and 2,900+ other apps remarkably fast.

Trigger workflow on

New Delivery from the Thanks.io API

Next, do this

Add Data Store Record with the NiftyImages 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 Thanks.io trigger and NiftyImages action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Delivery trigger
1. Connect your Thanks.io account
2. Configure Polling interval
3. Optional- Select a Sub Account
Configure the Add Data Store Record action
1. Connect your NiftyImages account
2. Configure Data Store API Key
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 Delivery on Thanks.io

Description:Emit new event for each new order delivered.

Version:0.0.3

Key:thanks_io-new-delivery

View on GitHub

Thanks.io Overview#

The Thanks.io API lets you automate the sending of personalized postcards and letters. This API can be harnessed to craft tailored outreach campaigns, customer appreciation notes, or event-based mailings. By integrating with Pipedream, you can create intelligent, event-driven workflows that trigger mailings based on user activity, data changes, or milestones achieved in other apps, streamlining the way businesses and developers connect with their audiences physically.

Trigger Code#

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

export default {
  ...common,
  key: "thanks_io-new-delivery",
  name: "New Delivery",
  description: "Emit new event for each new order delivered.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  hooks: {
    async deploy() {
      const params = this.subAccount
        ? {
          sub_account_id: this.subAccount,
        }
        : undefined;
      const { data: orders } = await this.thanksIo.listOrders({
        params,
      });
      let count = 0;
      for (const order of orders) {
        if (order.status === "Delivered") {
          this.$emit(order, this.generateMeta(order));
          count ++;
        }
        if (count === 25) {
          break;
        }
      }
    },
  },
  methods: {
    ...common.methods,
    generateMeta(order) {
      return {
        id: order.id,
        summary: `Order delivered: ${order.id}`,
        ts: Date.parse(order?.updated_at?.date),
      };
    },
  },
  async run() {
    const params = this.subaccount
      ? {
        sub_account_id: this.subaccount,
      }
      : undefined;

    const orders = await this.paginate(this.thanksIo.listOrders, params);
    for (const order of orders) {
      if (order.status === "Delivered") {
        this.$emit(order, this.generateMeta(order));
      }
    }
  },
};

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
Thanks.io	`thanksIo`	`app`	This component uses the Thanks.io 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 API on this schedule
Sub Account	`subAccount`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Thanks.io#

Direct Mail Sent Digitally

Action#

Add Data Store Record on NiftyImages

Description:Create or update a Data Store Record [See docs here](https://api.niftyimages.com/)

Version:0.0.2

Key:niftyimages-add-data-store-record

View on GitHub

NiftyImages Overview#

The NiftyImages API allows for the dynamic creation and customization of images for email marketing campaigns. By automating image personalization, users can create unique, engaging visuals that resonate with each recipient. It's possible to insert text into images, generate countdown timers, and manipulate image URLs on the fly, enhancing the visual appeal and relevance of marketing messages.

Action Code#

import niftyimages from "../../app/niftyimages.app.mjs";
import { defineAction } from "@pipedream/types";
import { ConfigurationError } from "@pipedream/platform";
export default defineAction({
    name: "Add Data Store Record",
    description: "Create or update a Data Store Record [See docs here](https://api.niftyimages.com/)",
    key: "niftyimages-add-data-store-record",
    version: "0.0.2",
    annotations: {
        destructiveHint: true,
        openWorldHint: true,
        readOnlyHint: false,
    },
    type: "action",
    props: {
        niftyimages,
        dataStoreApiKey: {
            label: "Data Store API Key",
            description: `The API Key for the Data Store you want to create/update a record on.
        \\
        To find this, go to **Data Sources**, choose a Data Store, and click on **"Use Our API"**.
        \\
        *Note that only a **Custom Store** can be updated.*`,
            type: "string",
            reloadProps: true,
        },
    },
    async additionalProps() {
        const newProps = {};
        const apiKey = this.dataStoreApiKey?.trim();
        let fields;
        try {
            fields = await this.niftyimages.getDataStoreFields(apiKey);
        }
        catch (err) {
            throw new ConfigurationError(`Error fetching data - please check the **API Key**.
        
\`${err.message}\``);
        }
        const newPropNames = [];
        fields.forEach((field) => {
            const { name, type, date_input_format, } = field;
            newProps[name] = {
                label: this.niftyimages.getFieldLabel(field),
                description: date_input_format
                    ? `Must be a date in the \`${date_input_format}\` format`
                    : undefined,
                type: this.niftyimages.getFieldPropType(type),
            };
            newPropNames.push(name);
        });
        newProps["$fieldNames"] = {
            label: "Fields to Update",
            description: "Comma-separated list of the fields to be updated (defaults to all).",
            type: "string",
            optional: true,
            default: newPropNames.join(),
        };
        return newProps;
    },
    async run({ $ }) {
        // I had to explicitly cast the type here due to a current limitation
        // in the action type combined with the additionalProps method
        const $this = this;
        const strNames = $this.$fieldNames?.trim();
        if (!strNames) {
            throw new ConfigurationError("Please check the `Fields to Update` prop.");
        }
        const data = {};
        strNames.split(",").forEach((fieldName) => {
            const name = fieldName.trim();
            data[name] = $this[name];
        });
        const params = {
            $,
            apiKey: $this.dataStoreApiKey,
            data,
        };
        const response = await $this.niftyimages.addRecord(params);
        $.export("$summary", "Updated record successfully");
        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
NiftyImages	`niftyimages`	`app`	This component uses the NiftyImages app.
Data Store API Key	`dataStoreApiKey`	`string`	The API Key for the Data Store you want to create/update a record on. To find this, go to Data Sources, choose a Data Store, and click on "Use Our API". Note that only a Custom Store* can be updated.*

Action Authentication#

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

To retrieve your API key,