Associate one identity with another with Segment API on New Channel Message from Microsoft Teams API

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

Trigger workflow on

New Channel Message from the Microsoft Teams API

Next, do this

Associate one identity with another 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 Microsoft Teams 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 Channel Message trigger
1. Connect your Microsoft Teams account
2. Configure Polling interval
3. Select a Team
4. Select a Channel
Configure the Associate one identity with another action
1. Connect your Segment account
2. Optional- Configure Context
3. Optional- Configure Integrations
4. Configure Previous ID
5. Optional- Configure Timestamp
6. 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 Channel Message on Microsoft Teams

Description:Emit new event when a new message is posted in a channel

Version:0.0.9

Key:microsoft_teams-new-channel-message

View on GitHub

Microsoft Teams Overview#

The Microsoft Teams API on Pipedream allows you to automate tasks, streamline communication, and integrate with other services to enhance the functionality of Teams as a collaboration hub. With this API, you can send messages to channels, orchestrate complex workflows based on Teams events, and manage Teams' settings programmatically.

Trigger Code#

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

export default {
  ...base,
  key: "microsoft_teams-new-channel-message",
  name: "New Channel Message",
  description: "Emit new event when a new message is posted in a channel",
  version: "0.0.9",
  type: "source",
  dedupe: "unique",
  props: {
    ...base.props,
    team: {
      propDefinition: [
        base.props.microsoftTeams,
        "team",
      ],
    },
    channel: {
      propDefinition: [
        base.props.microsoftTeams,
        "channel",
        (c) => ({
          teamId: c.team,
        }),
      ],
    },
  },
  methods: {
    ...base.methods,
    async getResources(lastCreated) {
      return this.getNewPaginatedResources(
        this.microsoftTeams.listChannelMessages,
        {
          teamId: this.team,
          channelId: this.channel,
        },
        lastCreated,
      );
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: `New Message ${message.id}`,
        ts: Date.parse(message.createdDateTime),
      };
    },
  },
};

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
Microsoft Teams	`microsoftTeams`	`app`	This component uses the Microsoft Teams 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 YouTube API on this schedule
Team	`team`	`string`	Select a value from the drop down menu.
Channel	`channel`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

User.Reademailoffline_accessopenidprofileChat.ReadChat.ReadWriteChatMessage.SendChannel.ReadBasic.AllChannelMessage.Read.AllChannelMessage.SendTeam.ReadBasic.AllSchedule.Read.All

About Microsoft Teams#

Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.

Action#

Associate one identity with another on Segment

Description:Alias is how you associate one identity with another. See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#alias)

Version:0.1.4

Key:segment-alias

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-alias",
  name: "Associate one identity with another",
  description: "Alias is how you associate one identity with another. See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#alias)",
  version: "0.1.4",
  type: "action",
  props: {
    segmentApp,
    context: {
      propDefinition: [
        segmentApp,
        "context",
      ],
    },
    integrations: {
      propDefinition: [
        segmentApp,
        "integrations",
      ],
    },
    previousId: {
      type: "string",
      label: "Previous ID",
      description: "Previous unique identifier for the user",
    },
    timestamp: {
      propDefinition: [
        segmentApp,
        "timestamp",
      ],
    },
    userId: {
      propDefinition: [
        segmentApp,
        "userId",
      ],
    },
  },
  async run({ $ }) {
    return this.segmentApp.alias({
      $,
      data: {
        context: this.context,
        integrations: this.integrations,
        previousId: this.previousId,
        timestamp: this.timestamp,
        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.
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
Integrations	`integrations`	`object`	Dictionary of destinations to either enable or disable
Previous ID	`previousId`	`string`	Previous unique identifier for the user
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`
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.