Create a New Campaign with Stannp API on New Organization Post Created from LinkedIn API

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

Trigger workflow on

New Organization Post Created from the LinkedIn 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 LinkedIn 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 Organization Post Created trigger
1. Connect your LinkedIn account
2. Configure Polling Schedule
3. Configure Organization Vanity Name
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 PDF File Path or URL
10. Optional- Configure Front Image Path or URL
11. Optional- Configure Back Image Path or URL
12. Optional- Configure syncDir
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 Organization Post Created on LinkedIn

Description:Emit new event when a new post is created by the organization. [See the documentation](https://learn.microsoft.com/en-us/linkedin/marketing/community-management/shares/posts-api?view=li-lms-2024-09&tabs=curl#find-posts-by-authors).

Version:0.0.1

Key:linkedin-new-organization-post-created

View on GitHub

LinkedIn Overview#

The LinkedIn API on Pipedream allows you to automate interactions with your LinkedIn account, such as posting updates, managing your profile, and engaging with your network. With Pipedream's serverless platform, you can create workflows that trigger on various events, process data, and connect with countless other apps to extend your LinkedIn presence, analyze your network's demographics, automate content sharing, and more.

Trigger Code#

import { ConfigurationError } from "@pipedream/platform";
import common from "../common/polling.mjs";
import utils from "../../common/utils.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "linkedin-new-organization-post-created",
  name: "New Organization Post Created",
  description: "Emit new event when a new post is created by the organization. [See the documentation](https://learn.microsoft.com/en-us/linkedin/marketing/community-management/shares/posts-api?view=li-lms-2024-09&tabs=curl#find-posts-by-authors).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    ...common.props,
    organizationVanityName: {
      type: "string",
      label: "Organization Vanity Name",
      description: "You can get the Orgainization Vanity Name from the company LinkedIN URL, for example, if the company LinkedIn URL is `https://www.linkedin.com/company/confluent`, then the Organization Vanity Name is `confluent`.",
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      const {
        app,
        organizationVanityName,
        setOrganizationId,
        setIsFirstRun,
      } = this;

      const { elements } = await app.searchOrganizations("vanityName", {
        debug: true,
        params: {
          vanityName: organizationVanityName,
        },
        paramsSerializer: utils.getParamsSerializer(utils.encodeFn),
      });

      const organizationFound =
        elements?.find(({ vanityName }) => vanityName === organizationVanityName);

      if (!organizationFound) {
        throw new ConfigurationError(`There's no Organization matched for Organization Vanity Name \`${organizationVanityName}\`.`);
      }

      setOrganizationId(organizationFound.id);
      setIsFirstRun(true);
    },
  },
  methods: {
    ...common.methods,
    getDateField() {
      return "createdAt";
    },
    getResourceName() {
      return "elements";
    },
    getResourcesFn() {
      return this.app.listPosts;
    },
    getResourcesFnArgs() {
      const author = `urn:li:organization:${this.getOrganizationId()}`;
      return {
        debug: true,
        params: {
          author,
          q: "author",
          sortBy: "CREATED",
        },
      };
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Org Post: ${resource.id}`,
        ts: resource.createdAt,
      };
    },
  },
  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
LinkedIn	`app`	`app`	This component uses the LinkedIn app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Schedule	`timer`	`$.interface.timer`	How often to poll the API
Organization Vanity Name	`organizationVanityName`	`string`	You can get the Orgainization Vanity Name from the company LinkedIN URL, for example, if the company LinkedIn URL is `https://www.linkedin.com/company/confluent`, then the Organization Vanity Name is `confluent`.

Trigger Authentication#

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

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

r_1st_connections_sizer_ads_reportingrw_organization_adminw_organization_socialr_organization_socialw_member_social_feedw_member_socialw_organization_social_feedr_basicprofilerw_adsr_organization_social_feedr_ads

About LinkedIn#

LinkedIn is a business and employment-focused social media platform. Manage your professional identity. Build and engage with your professional network. Access knowledge, insights and opportunities.

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.1.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 { getFileData } 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.1.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: "PDF File Path or URL",
      description: "A PDF file to use as the design artwork. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)",
      optional: true,
      reloadProps: true,
    },
    front: {
      type: "string",
      label: "Front Image Path or URL",
      description: "A PDF or JPG file to use as the front image. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`)",
      optional: true,
      reloadProps: true,
    },
    back: {
      type: "string",
      label: "Back Image Path or URL",
      description: "A PDF or JPG file to use as the back image. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`)",
      optional: true,
      reloadProps: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: 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) {
      const {
        stream, metadata,
      } = await getFileData(file);
      formData.append("file", stream, metadata);
    }
    if (front) {
      const {
        stream, metadata,
      } = await getFileData(front);
      formData.append("front", stream, metadata);
    }
    if (back) {
      const {
        stream, metadata,
      } = await getFileData(back);
      formData.append("back", stream, metadata);
    }

    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.
PDF File Path or URL	`file`	`string`	A PDF file to use as the design artwork. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)
Front Image Path or URL	`front`	`string`	A PDF or JPG file to use as the front image. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`)
Back Image Path or URL	`back`	`string`	A PDF or JPG file to use as the back image. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`)
syncDir	`syncDir`	`dir`

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,