Create a New Campaign with Stannp API on Webhook Destination (Instant) from Segment API

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

Trigger workflow on

Webhook Destination (Instant) from the Segment 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 Segment 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 Webhook Destination (Instant) trigger
1. Connect your Segment account
2. Select a Workspace
3. Select a Source
4. Configure Name
5. Optional- Configure Trigger
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#

Webhook Destination (Instant) on Segment

Description:Send events to a webhook. Requires a Team or Business account.

Version:0.0.2

Key:segment-webhook-destination

View on GitHub

Segment Overview#

The Segment API enables you to collect, manage, and route your customer analytics data to various tools for marketing, analytics, and data warehousing. By harnessing the Segment API on Pipedream, you can automate the ingestion and syncing of user events and properties to multiple destinations, allowing you to create seamless data pipelines without manual intervention. Pipedream's serverless platform empowers you to build custom workflows that react to events in real-time, enrich data, or trigger actions across your tech stack.

Trigger Code#

import segmentApp from "../../segment.app.mjs";

export default {
  key: "segment-webhook-destination",
  name: "Webhook Destination (Instant)",
  description: "Send events to a webhook. Requires a Team or Business account.",
  version: "0.0.2",
  type: "source",
  props: {
    segmentApp,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    workspace: {
      propDefinition: [
        segmentApp,
        "workspace",
      ],
    },
    source: {
      propDefinition: [
        segmentApp,
        "source",
        ({ workspace }) => ({
          workspace,
        }),
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "Defines the display name of the Destination",
    },
    trigger: {
      type: "string",
      label: "Trigger",
      description: "Destination FQL Statement. [Filter Query Language](https://segment.com/docs/api/public-api/fql/)",
      optional: true,
      default: "type = \"identify\" or type = \"track\" or type = \"group\"",
    },
  },
  hooks: {
    async activate() {
      const { data } = await this.segmentApp.createDestination({
        data: {
          sourceId: this.source,
          metadataId: await this.findMetadataId(),
          name: this.name,
          enabled: true,
          connection_mode: "UNSPECIFIED",
          settings: {},
        },
      });
      const destinationId = data.destination.id;
      this.setDestinationId(destinationId);

      const response = await this.segmentApp.createDestinationSubscription({
        destination: destinationId,
        data: {
          name: "Pipedream Webhook Subscription",
          trigger: this.trigger,
          actionId: await this.findActionId(destinationId),
          enabled: true,
          settings: {
            method: "POST",
            url: this.http.endpoint,
          },
        },
      });
      const subscriptionId = response.data.destinationSubscription.id;
      this.setSubscriptionId(subscriptionId);
    },
    async deactivate() {
      const destination = this.getDestinationId();
      const subscription = this.getSubscriptionId();
      await this.segmentApp.deleteDestinationSubscription({
        destination,
        subscription,
      });
      await this.segmentApp.deleteDestination({
        destination,
      });
    },
  },
  methods: {
    getDestination() {
      return "actions-webhook";
    },
    setDestinationId(id) {
      this.db.set("destinationId", id);
    },
    getDestinationId() {
      return this.db.get("destinationId");
    },
    setSubscriptionId(id) {
      this.db.set("subscriptionId", id);
    },
    getSubscriptionId() {
      return this.db.get("subscriptionId");
    },
    async findDestinationMetadataId() {
      const params = {
        pagination: {
          count: 200,
        },
      };
      do {
        const {
          data: {
            destinationsCatalog, pagination,
          },
        } = await this.segmentApp.getDestinationsCatalog({
          params,
        });
        const destination = destinationsCatalog.find(({ slug }) => slug === this.getDestination());
        if (destination) {
          return destination.id;
        }
        params.pagination.cursor = pagination?.next;
      } while (params.pagination.cursor);
    },
    async findMetadataId() {
      const destinationMetadataId = await this.findDestinationMetadataId();
      const { data: { destinationMetadata } } =  await this.segmentApp.getDestinationMetadata({
        destinationMetadataId,
      });
      if (!destinationMetadata?.id) {
        throw new Error(`MetadataId for ${this.getDestination()} not found.`);
      }
      return destinationMetadata.id;
    },
    async findActionId(destination) {
      const { data } = await this.segmentApp.getDestination({
        destination,
      });
      return data.destination.metadata.actions[0].id;
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    this.$emit(event, {
      id: Date.now(),
      summary: "Received event",
      ts: Date.now(),
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment 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.
Workspace	`workspace`	`string`	Select a value from the drop down menu.
Source	`source`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Defines the display name of the Destination
Trigger	`trigger`	`string`	Destination FQL Statement. Filter Query Language

Trigger Authentication#

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

Segment's APIs are accessed programmatically using access tokens, as well as write keys.

Access Token

Create access tokens via the Access Management page in your account: https://app.segment.com/{your-workspace-name}/settings/access-management. See "Get a Token" for more details. Please note, that you must be on a Team or Business plan to create an access token.

Write Key

You will also need to find your write key, which is a unique identifier for your Source. To find a write key, you first need to create a non-Cloud Source such as a website, server, or mobile source. (Cloud-sources do not have write keys, as they use a token or key from your account with that service.) Then, in the Source, go to “Settings’, and then go to “API Keys”. See "Locating Your Write Key" for more details.

About Segment#

Customer data platform

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.2

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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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,

Navigate to your Stannp account and sign in
Go to “Settings” > “API Settings”

About Stannp#

Create and send postal Direct Mail campaigns: letters or postcards.

More Ways to Connect Stannp + Segment#

Other Popular Integrations#

Get a Single Campaign with Stannp API on Webhook Destination (Instant) from Segment API

Segment + Stannp

Try it

Create a New Recipient with Stannp API on Webhook Destination (Instant) from Segment API

Segment + Stannp

Try it

Associate one identity with another with Segment API on New Recipient Created from Stannp API

Stannp + Segment

Try it

Associate an identified user with a group with Segment API on New Recipient Created from Stannp API

Stannp + Segment

Try it

Identify a user, tie them to their actions and record traits about them with Segment API on New Recipient Created from Stannp API

Stannp + Segment

Try it

Popular Triggers#

Webhook Destination (Instant) from the Segment API

Send events to a webhook. Requires a Team or Business account.

Try it

New Campaign Created from the Stannp API

Emit new event when a new campaign is created in Stannp.

Try it

New Recipient Created from the Stannp API

Emit new event when a new recipient is created.

Try it

Popular Actions#

Associate an identified user with a group with the Segment API

Group lets you associate an identified user with a group (note requires userId or anonymousId). See the docs here

Try it

Associate one identity with another with the Segment API

Alias is how you associate one identity with another. See the docs here

Try it

Identify a user, tie them to their actions and record traits about them with the Segment API

Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs here

Try it

Record page views on your website with the Segment API

The page method lets you record page views on your website, along with optional extra information about the page being viewed (note requires userId or anonymousId). See the docs here

Try it

Record whenever a user sees a screen with the Segment API

The screen method let you record whenever a user sees a screen of your mobile app (note requires userId or anonymousId). See the docs here

Try it