Back to Zulip

Generate URL for an integration

starlight_help/src/content/docs/generate-integration-url.mdx

12.02.5 KB
Original Source

import {TabItem, Tabs} from "@astrojs/starlight/components";

import FlattenedSteps from "../../components/FlattenedSteps.astro"; import NavigationSteps from "../../components/NavigationSteps.astro"; import AdminOnly from "../include/_AdminOnly.mdx";

import LinkIcon from "~icons/zulip-icon/link-2"; import UserCogIcon from "~icons/zulip-icon/user-cog";

Many Zulip integrations are webhooks. An incoming webhook integration allows a third-party service, such as an issue tracker or an alerting tool, to post updates to Zulip. To configure where these updates will be posted, you need to generate a special Zulip integration URL.

<Tabs> <TabItem label="Your bots"> <FlattenedSteps> <NavigationSteps target="settings/your-bots" />
  1. In the **Actions** column, click the **link** (<LinkIcon />) icon for
     the **Incoming webhook** bot.
  1. Select the desired integration from the **Integration** dropdown.
  1. *(optional)* Select the destination channel from the
     **Where to send notifications** dropdown.
  1. *(optional)* Select **Send all notifications to a single topic**, and
     enter the topic name.
  1. *(optional)* Select **Filter events that will trigger notifications?**,
     and select which supported events should trigger notifications.
  1. Click **Copy URL** to add the URL to your clipboard.
</FlattenedSteps>
</TabItem> <TabItem label="All bots"> <AdminOnly />
<FlattenedSteps>
  <NavigationSteps target="settings/bots" />

  1. In the **Actions** column, click the **link** (<LinkIcon />) icon for
     the **Incoming webhook** bot.
  1. Select the desired integration from the **Integration** dropdown.
  1. *(optional)* Select the destination channel from the
     **Where to send notifications** dropdown.
  1. *(optional)* Select **Send all notifications to a single topic**, and
     enter the topic name.
  1. *(optional)* Select **Filter events that will trigger notifications?**,
     and select which supported events should trigger notifications.
  1. Click **Copy URL** to add the URL to your clipboard.
</FlattenedSteps>
</TabItem> </Tabs>