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

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

Trigger workflow on

New Campaign Created from the Stannp API

Next, do this

Associate an identified user with a group with the Segment 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 Stannp trigger and Segment action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Campaign Created trigger
1. Connect your Stannp account
2. Configure timer
Configure the Associate an identified user with a group action
1. Connect your Segment account
2. Optional- Configure Anonymous ID
3. Optional- Configure Context
4. Configure Group ID
5. Optional- Configure Integrations
6. Optional- Configure Timestamp
7. Optional- Configure Traits
8. Optional- Configure User ID
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 Campaign Created on Stannp

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

Version:0.0.1

Key:stannp-new-campaign-created

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.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "stannp-new-campaign-created",
  name: "New Campaign Created",
  description: "Emit new event when a new campaign is created in Stannp.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSummary(campaign) {
      return `New Campaign: ${campaign.name}`;
    },
    async startEvent(maxResults = 0) {
      const lastId = this._getLastId();

      const response = this.stannp.paginate({
        fn: this.stannp.listCampaigns,
        maxResults,
      });

      let responseArray = [];

      for await (const item of response) {
        if (item.id <= lastId) break;
        responseArray.push(item);
      }

      if (responseArray.length) this._setLastId(responseArray[0].id);

      for (const item of responseArray.reverse()) {
        this.$emit(item, this.generateMeta(item));
      }
    },
  },
};

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
Stannp	`stannp`	`app`	This component uses the Stannp app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

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

Action#

Associate an identified user with a group on Segment

Description:Group lets you associate an identified user with a group (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#group)

Version:0.2.4

Key:segment-group

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.

Action Code#

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

export default {
  key: "segment-group",
  name: "Associate an identified user with a group",
  description: "Group lets you associate an identified user with a group (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#group)",
  version: "0.2.4",
  type: "action",
  props: {
    segmentApp,
    anonymousId: {
      propDefinition: [
        segmentApp,
        "anonymousId",
      ],
    },
    context: {
      propDefinition: [
        segmentApp,
        "context",
      ],
    },
    groupId: {
      type: "string",
      label: "Group ID",
      description: "A unique identifier for the group in your database.",
    },
    integrations: {
      propDefinition: [
        segmentApp,
        "integrations",
      ],
    },
    timestamp: {
      propDefinition: [
        segmentApp,
        "timestamp",
      ],
    },
    traits: {
      type: "object",
      label: "Traits",
      description: "Free-form dictionary of traits of the group, like email or name.",
      optional: true,
    },
    userId: {
      propDefinition: [
        segmentApp,
        "userId",
      ],
    },
  },
  async run({ $ }) {
    return this.segmentApp.group({
      $,
      data: {
        anonymousId: this.anonymousId,
        context: this.context,
        groupId: this.groupId,
        integrations: this.integrations,
        timestamp: this.timestamp,
        traits: this.traits,
        userId: this.userId,
      },
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment app.
Anonymous ID	`anonymousId`	`string`	A pseudo-unique substitute for a User ID, for cases when you don't have an absolutely unique identifier. A User ID or an Anonymous ID is required.
Context	`context`	`object`	Dictionary of extra information that provides useful context about a message, but is not directly related to the API call like ip address or locale
Group ID	`groupId`	`string`	A unique identifier for the group in your database.
Integrations	`integrations`	`object`	Dictionary of destinations to either enable or disable
Timestamp	`timestamp`	`string`	Timestamp when the message itself took place, defaulted to the current time by the Segment Tracking API. It is an ISO-8601 date string. For example, `2022-04-08T17:32:11.318Z`
Traits	`traits`	`object`	Free-form dictionary of traits of the group, like email or name.
User ID	`userId`	`string`	Unique identifier for the user in your database., A User ID or an Anonymous ID is required.

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