Create a New Campaign with Stannp API on New Inventory Update from Vend API

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

Trigger workflow on

New Inventory Update from the Vend API

Next, do this

Create a New Campaign with the Stannp 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 Vend 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 Inventory Update trigger
1. Connect your Vend account
2. Select a Event Type
Configure the Create a New Campaign action
1. Connect your Stannp account
2. Configure Campaign Name
3. Select a Campaign Type
4. Optional- Configure Template ID
5. Optional- Select a Group ID
6. Optional- Select a What Recipients
7. Optional- Configure Addons
8. Optional- Configure Admail
9. Optional- Configure File
10. Optional- Configure Front
11. Optional- Configure Back
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 Inventory Update on Vend

Description:Emit new event for each update on inventory. [See docs here](https://docs.vendhq.com/reference/post-webhooks)

Version:0.0.1

Key:vend-inventory-update

View on GitHub

Vend Overview#

The Vend API offers programmatic access to retail management features, enabling users to automate processes related to inventory, sales, products, customers, and more within their retail business. Through Pipedream, you can harness this API to create custom workflows that trigger on various events within Vend, process data, integrate with other apps, and automate actions to streamline retail operations, enhance customer engagement, and optimize sales strategies.

Trigger Code#

import vend from "../../vend.app.mjs";
import constants from "../common/constants.mjs";

export default {
  name: "New Inventory Update",
  version: "0.0.1",
  key: "vend-inventory-update",
  description: "Emit new event for each update on inventory. [See docs here](https://docs.vendhq.com/reference/post-webhooks)",
  type: "source",
  dedupe: "unique",
  props: {
    vend,
    db: "$.service.db",
    http: "$.interface.http",
    eventType: {
      label: "Event Type",
      description: "The type of the event",
      type: "string",
      options: constants.WEBHOOK_EVENT_TYPES,
    },
  },
  methods: {
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
  },
  hooks: {
    async activate() {
      const response = await this.vend.createWebhook({
        url: this.http.endpoint,
        active: true,
        type: this.eventType,
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.vend.removeWebhook(webhookId);
    },
  },
  async run(event) {
    const { body: { payload } } = event;

    const resource = JSON.parse(payload);

    const ts = new Date();

    this.$emit(resource, {
      id: ts,
      summary: `New event ${this.eventType} (${resource.id}) `,
      ts: 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
Vend	`vend`	`app`	This component uses the Vend 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.
Event Type	`eventType`	`string`	Select a value from the drop down menu:`{ "label": "Sale Update", "value": "sale.update" }{ "label": "Product Update", "value": "product.update" }{ "label": "Customer Update", "value": "customer.update" }{ "label": "Inventory Update", "value": "inventory.update" }{ "label": "Register Closure Create", "value": "register_closure.create" }{ "label": "Register Closure Update", "value": "register_closure.update" }{ "label": "Consignment Send", "value": "consignment.send" }{ "label": "Consignment Receive", "value": "consignment.receive" }`

Trigger Authentication#

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

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

About Vend#

Retail POS Software

Action#

Create a New Campaign on Stannp

Description:Create a new campaign in Stannp. [See the documentation](https://www.stannp.com/us/direct-mail-api/campaigns)

Version:0.0.1

Key:stannp-create-campaign

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 FormData from "form-data";
import {
  TYPE_OPTIONS, WHAT_RECIPIENTS_OPTIONS,
} from "../../common/constants.mjs";
import { checkFile } from "../../common/utils.mjs";
import stannp from "../../stannp.app.mjs";

export default {
  key: "stannp-create-campaign",
  name: "Create a New Campaign",
  description: "Create a new campaign in Stannp. [See the documentation](https://www.stannp.com/us/direct-mail-api/campaigns)",
  version: "0.0.1",
  type: "action",
  props: {
    stannp,
    name: {
      type: "string",
      label: "Campaign Name",
      description: "Name your campaign for reference.",
    },
    type: {
      type: "string",
      label: "Campaign Type",
      description: "The type of campaign this will be. Make sure the image is in the correct format.",
      options: TYPE_OPTIONS,
    },
    templateId: {
      type: "string",
      label: "Template ID",
      description: "Select the template ID",
      optional: true,
    },
    groupId: {
      propDefinition: [
        stannp,
        "groupId",
      ],
      optional: true,
    },
    whatRecipients: {
      type: "string",
      label: "What Recipients",
      description: "What recipients do you want this campaign to go to?",
      options: WHAT_RECIPIENTS_OPTIONS,
      optional: true,
    },
    addons: {
      type: "string",
      label: "Addons",
      description: "If you have an addon code.",
      optional: true,
    },
    admail: {
      type: "boolean",
      label: "Admail",
      description: "Set to true to benefit from admail discounts. Must comply with advertising mail restrictions.",
      optional: true,
    },
    file: {
      type: "string",
      label: "File",
      description: "A single or multi-page PDF file to use as the design artwork. can be a URL or a path to a file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp). Make sure the image is in the correct format.",
      optional: true,
      reloadProps: true,
    },
    front: {
      type: "string",
      label: "Front",
      description: "A PDF or JPG file to use as the front image. Can be a URL or a path to a file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp). Make sure the image is in the correct format.",
      optional: true,
      reloadProps: true,
    },
    back: {
      type: "string",
      label: "Back",
      description: "A PDF or JPG file to use as the back image. Can be a URL or a path to a file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp). Make sure the image is in the correct format.",
      optional: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    let optional = true;
    if (this.file || this.front || this.back) {
      optional = false;
    }
    return {
      size: {
        type: "string",
        label: "Size",
        description: "Example '4x6' or '6x9' or 6x11'",
        optional,
      },
    };
  },
  async run({ $ }) {
    const {
      stannp,
      templateId,
      groupId,
      whatRecipients,
      file,
      front,
      back,
      admail,
      ...data
    } = this;

    const formData = new FormData();

    if (file) formData.append("file", await checkFile(file));
    if (front) formData.append("front", await checkFile(front));
    if (back) formData.append("back", await checkFile(back));

    if (templateId) formData.append("template_id", templateId);
    if (groupId) formData.append("group_id", groupId);
    if (whatRecipients) formData.append("what_recipients", whatRecipients);
    if (typeof admail === "boolean") formData.append("admail", `${admail}`);
    for (const [
      key,
      value,
    ] of Object.entries(data)) {
      formData.append(key, value);
    }

    const response = await stannp.createCampaign({
      $,
      data: formData,
      headers: formData.getHeaders(),
    });

    $.export("$summary", `Successfully created campaign with ID: ${response.data}`);
    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.
Campaign Name	`name`	`string`	Name your campaign for reference.
Campaign Type	`type`	`string`	Select a value from the drop down menu:`4x6-postcard6x9-postcardus-letter`
Template ID	`templateId`	`string`	Select the template ID
Group ID	`groupId`	`string`	Select a value from the drop down menu.
What Recipients	`whatRecipients`	`string`	Select a value from the drop down menu:`allvalidnot_validint`
Addons	`addons`	`string`	If you have an addon code.
Admail	`admail`	`boolean`	Set to true to benefit from admail discounts. Must comply with advertising mail restrictions.
File	`file`	`string`	A single or multi-page PDF file to use as the design artwork. can be a URL or a path to a file in the `/tmp` directory. See the documentation on working with files. Make sure the image is in the correct format.
Front	`front`	`string`	A PDF or JPG file to use as the front image. Can be a URL or a path to a file in the `/tmp` directory. See the documentation on working with files. Make sure the image is in the correct format.
Back	`back`	`string`	A PDF or JPG file to use as the back image. Can be a URL or a path to a file in the `/tmp` directory. See the documentation on working with files. Make sure the image is in the correct format.

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,