Create Guild Channel with Discord Bot API on Webhook Destination (Instant) from Segment API

Pipedream makes it easy to connect APIs for Discord Bot, Segment and 1,600+ other apps remarkably fast.

Trigger workflow on

Webhook Destination (Instant) from the Segment API

Next, do this

Create Guild Channel with the Discord Bot API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 750,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Segment trigger and Discord Bot 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 Guild Channel action
1. Connect your Discord Bot account
2. Select a Guild
3. Configure Channel's name
4. Select a Channel type
5. Optional- Configure Position
6. Optional- Configure Topic
7. Optional- Configure NSFW
8. Optional- Configure Bitrate
9. Optional- Configure Rate limit per user
10. Optional- Configure User limit
11. Optional- Select a Category
12. Optional- Select one or more Roles to add
13. Optional- Select one or more Members to add
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#

You can do a lot of amazing things with Segment's API. Segment's API enables
you to collect and connect customer data quickly and easily. With it, you can
power your analytics, marketing, and data warehousing requirements, and improve
your customer experience and performance.

The Segment API provides you with full control over your customer data,
including file storage, ETL, data modeling, data enrichment and
transformations, and data queries. With it, you can build powerful solutions
that help you uncover useful customer insights in real-time. Here are a few
examples of what you can do using the Segment API:

Collect and store customer data from multiple sources: You can collect
customer data from multiple sources such as web traffic, mobile and web apps,
ecommerce stores, CRMs, and marketing automation platforms.
Build custom data models to gain deeper insights into customer behavior: With
the Segment API, you can build custom models that organize customer data into
meaningful categories to gain deeper consumer insights.
Automatically enrich customer data with 3rd party APIs: The Segment API
allows you to automatically map, enrich, and clean customer data, creating a
single source of truth for better segmentation and decision making.
Analyze customer data in real-time for better decision making: With the
Segment API, you can monitor customer data in real-time, uncovering patterns
and creating reports in a few clicks.
Automate data pipelines to quickly and easily access data: You can quickly
and easily create data pipelines with the Segment API, and get accurate data
delivered on demand.
Connect customer data to over 250 cloud services: With the Segment API, you
can quickly and easily connect customer data to over 250 cloud services and
systems, such as analytics, marketing automation platforms, CRMs, and data
warehouses.

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 Guild Channel on Discord Bot

Description:Create a new channel for the guild. [See the docs here](https://discord.com/developers/docs/resources/guild#create-guild-channel)

Version:0.0.13

Key:discord_bot-create-guild-channel

View on GitHub

Discord Bot Overview#

The Pipedream Discord app enables you to build event-driven workflows that interact with the Discord API. When you authorize the Pipedream app's access to your guilds, you can use Pipedream workflows to perform common Discord actions, or write your own code against the Discord API.

Action Code#

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

const { discord } = common.props;

export default {
  ...common,
  key: "discord_bot-create-guild-channel",
  name: "Create Guild Channel",
  description: "Create a new channel for the guild. [See the docs here](https://discord.com/developers/docs/resources/guild#create-guild-channel)",
  type: "action",
  version: "0.0.13",
  props: {
    ...common.props,
    name: {
      propDefinition: [
        discord,
        "channelName",
      ],
    },
    type: {
      type: "string",
      label: "Channel type",
      description: "Please select a channel type. In case you want to create a Store channel please read the docs [here](https://discord.com/developers/docs/game-and-server-management/special-channels#store-channels). If you want to create a Stage Voice channel please read the docs [here](https://support.discord.com/hc/en-us/articles/1500005513722#h_01F22AMCVKHQGQB8N3EF30B20C)",
      options: [
        {
          label: "Text",
          value: String(constants.CHANNEL_TYPES.GUILD_TEXT),
        },
        {
          label: "Voice",
          value: String(constants.CHANNEL_TYPES.GUILD_VOICE),
        },
        {
          label: "Category",
          value: String(constants.CHANNEL_TYPES.GUILD_CATEGORY),
        },
        {
          label: "Store",
          value: String(constants.CHANNEL_TYPES.GUILD_STORE),
        },
        {
          label: "Stage Voice",
          value: String(constants.CHANNEL_TYPES.GUILD_STAGE_VOICE),
        },
      ],
    },
    position: {
      propDefinition: [
        discord,
        "channelPosition",
      ],
    },
    topic: {
      propDefinition: [
        discord,
        "channelTopic",
      ],
    },
    nsfw: {
      propDefinition: [
        discord,
        "channelNsfw",
      ],
    },
    bitrate: {
      propDefinition: [
        discord,
        "channelBitrate",
      ],
    },
    rateLimitPerUser: {
      propDefinition: [
        discord,
        "channelRateLimitPerUser",
      ],
    },
    userLimit: {
      propDefinition: [
        discord,
        "channelUserLimit",
      ],
    },
    parentId: {
      propDefinition: [
        discord,
        "channelParentId",
        ({ guildId }) => ({
          guildId,
        }),
      ],
    },
    rolePermissions: {
      propDefinition: [
        discord,
        "channelRolePermissions",
        ({ guildId }) => ({
          guildId,
        }),
      ],
    },
    memberPermissions: {
      propDefinition: [
        discord,
        "channelMemberPermissions",
        ({ guildId }) => ({
          guildId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const {
      guildId,
      name,
      type,
      nsfw,
      topic,
      position,
      bitrate,
      rateLimitPerUser,
      userLimit,
      parentId,
      rolePermissions: rolePermissionStrs = [],
      memberPermissions: memberPermissionStrs = [],
    } = this;

    const permissionOverwrites = [
      ...rolePermissionStrs,
      ...memberPermissionStrs,
    ].map((str) => JSON.parse(str)).filter((p) => !(p.allow?.length === 0));

    const data = {
      name,
      // Pleas take a look at https://github.com/PipedreamHQ/pipedream/issues/1807
      // if we want to avoid this workaround in the future.
      type: +type,
      nsfw,
      topic,
      position,
      bitrate,
      rate_limit_per_user: rateLimitPerUser,
      user_limit: userLimit,
      parent_id: parentId,
      permission_overwrites: permissionOverwrites,
    };

    return this.discord.createChannel({
      $,
      guildId,
      data,
    });
  },
};

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
Discord Bot	`discord`	`app`	This component uses the Discord Bot app.
Guild	`guildId`	`string`	Select a value from the drop down menu.
Channel's name	`name`	`string`	There is a 1-100 character channel name restriction
Channel type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Text", "value": "0" }{ "label": "Voice", "value": "2" }{ "label": "Category", "value": "4" }{ "label": "Store", "value": "6" }{ "label": "Stage Voice", "value": "13" }`
Position	`position`	`integer`	The position of the channel in the left-hand listing
Topic	`topic`	`string`	0-1024 character channel topic
NSFW	`nsfw`	`boolean`	Not Safe For Wumpus
Bitrate	`bitrate`	`integer`	The bitrate (in bits) of the voice channel; 8000 to 96000 (128000 for VIP servers).
Rate limit per user	`rateLimitPerUser`	`integer`	Amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission manage_messages or manage_channel, are unaffected.
User limit	`userLimit`	`integer`	The user limit of the voice channel; 0 refers to no limit, 1 to 99 refers to a user limit.
Category	`parentId`	`string`	Select a value from the drop down menu.
Roles to add	`rolePermissions`	`string[]`	Select a value from the drop down menu.
Members to add	`memberPermissions`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

This app allows you to use the Discord API using your own Discord bot. If you don't want to use a custom bot, and you just need to use the Discord API, exit this screen and use the Discord app, instead.

If you want to use your own Discord bot, but haven't created one yet, see these instructions or watch this video. You'll need to add this bot to your server(s) to make successful API requests.

Once you've created your bot, you'll find the Bot token within the Bot section of your app. Enter that token below.

About Discord Bot#

Use this app to interact with the Discord API using a bot in your account

More Ways to Connect Discord Bot + Segment#

Other Popular Integrations#

Add Role with Discord Bot API on Webhook Destination (Instant) from Segment API

Segment + Discord Bot