Create Or Update Subscriber with AWeber API on New Send Created from Sendoso API

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

Trigger workflow on

New Send Created from the Sendoso API

Next, do this

Create Or Update Subscriber with the AWeber 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 Sendoso trigger and AWeber 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 Created trigger
1. Connect your Sendoso account
2. Configure Polling interval
Configure the Create Or Update Subscriber action
1. Connect your AWeber account
2. Select a Account ID
3. Select a List ID
4. Select a Email
5. Optional- Configure Name
6. Optional- Configure Tags
7. Optional- Configure Notes
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 Created on Sendoso

Description:Emit new event when a new send is created. [See docs here](https://sendoso.docs.apiary.io/#reference/send-management/get-all-sent-giftsitems/get-sent-gifts)

Version:0.0.1

Key:sendoso-new-send

View on GitHub

Sendoso Overview#

Sendoso is a sending platform that enables companies to engage with customers through direct mail, eGifts, and other physical deliveries. Utilizing the Sendoso API via Pipedream allows for the automation of these outreach efforts, seamlessly integrating with CRM systems, marketing automation, or customer support tools. By leveraging workflows and events, you can trigger Sendoso actions based on user behavior, sales milestones, or support tickets, enhancing the physical impact of your digital engagements.

Trigger Code#

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

export default {
  ...common,
  type: "source",
  name: "New Send Created",
  key: "sendoso-new-send",
  description: "Emit new event when a new send is created. [See docs here](https://sendoso.docs.apiary.io/#reference/send-management/get-all-sent-giftsitems/get-sent-gifts)",
  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,
      },
    },
  },
  methods: {
    ...common.methods,
    getDataToEmit({
      id, touch_name,
    }) {
      return {
        id: id,
        summary: this.getSummary(touch_name, id),
        ts: new Date().getTime(),
      };
    },
    getFieldId() {
      return "id";
    },
    getSummary(name, id) {
      return `New send created: ${name} (${id})`;
    },
    async proccessEvent() {
      const lastId = this._getLastId();
      const data = await this.sendoso.getSentGifts();

      const list = data.filter((item) => (item.id > lastId));

      list.reverse();
      this.emitEvent(list);
    },
    async startRun() {
      const data = await this.sendoso.getSentGifts();
      if (data.length > 20) data.length = 20;
      data.reverse();
      this.emitEvent(data);
    },
  },
};

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

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#

Create Or Update Subscriber on AWeber

Description:Create subscriber if the subscriber email is not existing or update the information for the specified subscriber by email. [See the docs here](https://api.aweber.com/#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers/patch).

Version:0.0.1

Key:aweber-create-or-update-subscriber

View on GitHub

AWeber Overview#

AWeber's API provides a suite of tools to automate email marketing efforts, enabling developers to manage subscribers, send emails, and track results programmatically. With the AWeber API on Pipedream, you can create custom workflows that react to various triggers and connect with other services to streamline your email campaigns, analyze performance, and enhance subscriber engagement.

Action Code#

import aweberApp from "../../aweber.app.mjs";

export default {
  key: "aweber-create-or-update-subscriber",
  name: "Create Or Update Subscriber",
  description: "Create subscriber if the subscriber email is not existing or update the information for the specified subscriber by email. [See the docs here](https://api.aweber.com/#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers/patch).",
  type: "action",
  version: "0.0.1",
  props: {
    aweberApp,
    accountId: {
      propDefinition: [
        aweberApp,
        "accountId",
      ],
    },
    listId: {
      propDefinition: [
        aweberApp,
        "listId",
        ({ accountId }) => ({
          accountId,
        }),
      ],
    },
    email: {
      propDefinition: [
        aweberApp,
        "email",
        ({
          accountId, listId,
        }) => ({
          accountId,
          listId,
        }),
      ],
    },
    name: {
      propDefinition: [
        aweberApp,
        "subscriberName",
      ],
      optional: true,
    },
    tags: {
      propDefinition: [
        aweberApp,
        "subscriberTags",
      ],
      optional: true,

    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Miscellaneous notes about the subscriber",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      accountId,
      listId,
      email,
      name,
      tags,
      notes,
    } = this;

    const subscribers = await this.aweberApp.getSubscribersForAccount({
      accountId,
      params: {
        "ws.op": "findSubscribers",
        email,
      },
    });

    let requestFn = subscribers?.entries?.length
      ? this.aweberApp.updateSubscriber
      : this.aweberApp.addSubscriber;

    const response = await requestFn({
      $,
      accountId,
      listId,
      email,
      data: {
        email,
        name,
        tags,
        notes,
      },
    });

    $.export("$summary", `Successfully created/updated subscriber with email ${email}.`);

    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
AWeber	`aweberApp`	`app`	This component uses the AWeber app.
Account ID	`accountId`	`integer`	Select a value from the drop down menu.
List ID	`listId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The subscriber's name
Tags	`tags`	`object`	This field is used to apply a list of tags to a Subscriber. With existing subscriber, you can add or remove the tag with this sample expression `{{ {"add": ["tag1"], "remove": ["tag2"]} }}`. With the new subscriber, you can add the tag with the array `{{ ["tag1", "tag2"] }}`
Notes	`notes`	`string`	Miscellaneous notes about the subscriber

Action Authentication#

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

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

account.readlist.readlist.writesubscriber.readsubscriber.writesubscriber.read-extendedemail.reademail.write