diff --git a/static/images/integrations/bot_avatars/onyx.png b/static/images/integrations/bot_avatars/onyx.png new file mode 100644 index 0000000000..c89ae39556 Binary files /dev/null and b/static/images/integrations/bot_avatars/onyx.png differ diff --git a/static/images/integrations/logos/onyx.png b/static/images/integrations/logos/onyx.png new file mode 100644 index 0000000000..93218889ff Binary files /dev/null and b/static/images/integrations/logos/onyx.png differ diff --git a/templates/zerver/integrations/onyx.md b/templates/zerver/integrations/onyx.md new file mode 100644 index 0000000000..72af285b69 --- /dev/null +++ b/templates/zerver/integrations/onyx.md @@ -0,0 +1,34 @@ +# Zulip Onyx Integration + +Export discussions from Zulip channels and topics to your Onyx knowledge +base! + +{start_tabs} + +1. {!create-a-generic-bot.md!} + +1. [Subscribe the bot][subscribe-channels] to the Zulip channels that you + want to export. + +1. Copy the bot's credentials by clicking the **copy** + () icon under the bot's name. + +1. In Onyx, open the **Admin Dashboard** and select the **Zulip Connector**. + +1. Under **Provide Credentials**, paste the credentials that you copied + above, and click **Update**. + +1. Set **Realm name** to the name of your Zulip organization, set + **Realm URL** to `{{ zulip_url }}`, and click **Connect**. + +{end_tabs} + +Congrats, you're done! You should be able to index Zulip from your Onyx +**Connectors Dashboard**! + +### Related documentation + +* [Zulip Connector documentation](https://docs.onyx.app/connectors/zulip) +* [About Onyx Connectors](https://docs.onyx.app/connectors/overview) + +[subscribe-channels]: /help/manage-user-channel-subscriptions#subscribe-a-user-to-a-channel diff --git a/zerver/lib/integrations.py b/zerver/lib/integrations.py index a368c9ff23..c534dadae5 100644 --- a/zerver/lib/integrations.py +++ b/zerver/lib/integrations.py @@ -588,6 +588,12 @@ INTEGRATIONS: dict[str, Integration] = { doc="zerver/integrations/openshift.md", stream_name="deployments", ), + "onyx": Integration( + "onyx", + ["productivity"], + logo="images/integrations/logos/onyx.png", + doc="zerver/integrations/onyx.md", + ), "perforce": Integration("perforce", ["version-control"], doc="zerver/integrations/perforce.md"), "phabricator": Integration( "phabricator", ["version-control"], doc="zerver/integrations/phabricator.md"