Run Node Code with Node API on New Send Status Updated from Sendoso API

Pipedream makes it easy to connect APIs for Node, Sendoso and 1000+ other apps remarkably fast.

Trigger workflow on

New Send Status Updated from the Sendoso API

Next, do this

Run Node Code with the Node API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Sendoso trigger and Node action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Send Status Updated trigger
1. Connect your Sendoso account
2. Configure Polling interval
3. Select a Tracking Id
Configure the Run Node Code action
1. Connect your Node account
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 Send Status Updated on Sendoso

Description:Emit new event when a send status is updated. [See docs here](https://sendoso.docs.apiary.io/#reference/send-management/send-tracking/fetch-the-status-of-a-send)

Version:0.0.1

Key:sendoso-send-status-updated

View on GitHub

Sendoso Overview#

The Sendoso API provides an easy-to-use platform to quickly and effectively
send physical gifts, cards, and other items to your customers, vendors, or
other key stakeholders. With the Sendoso API, you can build powerful customer
engagement campaigns that include personalized physical gifts and gestures.

The following are some of the things you can build using the Sendoso API:

Personalized bulk mailing campaigns, such as holiday cards or special
occasion items
Targeted customer experience campaigns that incorporate a unique physical
gift directly related to the customer journey
Automated thank you packages for key customers and vendors
Email programs that include personalized physical products
Invitation and promotional campaigns that incorporate physical gifts
Corporate gifting programs for employee recognition or development

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import common from "../common/base.mjs";

export default {
  ...common,
  type: "source",
  name: "New Send Status Updated",
  key: "sendoso-send-status-updated",
  description: "Emit new event when a send status is updated. [See docs here](https://sendoso.docs.apiary.io/#reference/send-management/send-tracking/fetch-the-status-of-a-send)",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Sendoso API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    trackingId: {
      propDefinition: [
        common.props.sendoso,
        "trackingId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getFunc() {
      return this.sendoso.getSentGifts;
    },
    getDataToEmit({
      date_and_time, status,
    }) {
      return {
        id: date_and_time,
        summary: this.getSummary(status),
        ts: new Date().getTime(date_and_time),
      };
    },
    getFieldId() {
      return "date_and_time";
    },
    getSummary(status) {
      return `Send status updated to ${status}`;
    },
    async prepareData() {
      const { trackingId } = this;
      const { activities } = await this.sendoso.getSendStatus({
        trackingId,
      });

      return activities[0].map((activity) => ({
        ...activity.activity,
      }));
    },
    async proccessEvent() {
      const lastTime = this._getLastId();
      const activities = await this.prepareData();
      const list = activities.filter((item) => moment(item.date_and_time).isAfter(lastTime));

      await this.emitEvent(list);
    },
    async startRun() {
      const activities = await this.prepareData();
      if (activities.length > 20) activities.length = 20;
      await this.emitEvent(activities);
    },
  },
};

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
Sendoso	`sendoso`	`app`	This component uses the Sendoso 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 Sendoso API on this schedule
Tracking Id	`trackingId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

publicwriteupdate

About Sendoso#

Sending platform

Action#

Run Node Code on Node

Description:Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.

Version:0.0.2

Key:node-run-node-code

View on GitHub

Action Code#

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

export default {
  name: "Run Node Code",
  version: "0.0.2",
  key: "node-run-node-code",
  description: "Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.",
  props: {
    node,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Return data to use it in future steps
    return steps.trigger.event;
  },
};