paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-30 19:43:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

integrations-docs: Make use of consistent spacing.

Browse Source
This commit is contained in:
Satyam Bansal
2023-07-17 22:35:17 +05:30
committed by Tim Abbott
parent 2ba2646730
commit 25cc0e4030
11 changed files with 57 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
zerver/webhooks/deskdotcom/doc.md
View File

@@ -1,17 +1,17 @@
1. {!create-stream.md!}
1. {!create-stream.md!}
Keep in mind you still need to create the stream first even
if you are using this recommendation.
1. {!create-an-incoming-webhook.md!}
1. {!create-an-incoming-webhook.md!}
1. Next, in Desk.com, open your **Admin** view via the top-left
1. Next, in Desk.com, open your **Admin** view via the top-left
dropdown. In the **Admin** view, click on **Apps**, then
click **Install** under **Custom Action**:
![](/static/images/integrations/desk/001.png)
1. From there, click **Install Custom Action** and accept the terms.
1. From there, click **Install Custom Action** and accept the terms.
Fill in the form like this:
* **Name**: Zulip
@@ -22,7 +22,7 @@
![](/static/images/integrations/desk/002.png)
1. Click **Create** to save your settings. From the next screen, click
1. Click **Create** to save your settings. From the next screen, click
**Add Action** to add a new action. You'll do this for every action
you want a notification on Zulip for. (To add another action later,
look for your custom action on the **Apps** page under
@@ -30,7 +30,7 @@
![](/static/images/integrations/desk/003.png)
1. Let's say you want a notification each time a case is updated. Put
1. Let's say you want a notification each time a case is updated. Put
in a descriptive name like **Announce case update**, select
**POST a string to a URL** for **Action Type**, and copy-paste this
to the **Appended URL path**:
@@ -45,7 +45,7 @@
it makes sure the notification goes to the appropriate stream and topic
within Zulip.
1. Next, copy this template Zulip message into **Message to POST**:
1. Next, copy this template Zulip message into **Message to POST**:
{% raw %}
@@ -65,13 +65,13 @@
![](/static/images/integrations/desk/004.png)
1. Click **Add Action** to save, and then on the next screen, click the
1. Click **Add Action** to save, and then on the next screen, click the
slider next to the action to enable it. This is important — actions are
turned off by default!
![](/static/images/integrations/desk/005.png)
1. Now you need to create a rule that triggers this action. Desk.com's
1. Now you need to create a rule that triggers this action. Desk.com's
support center has a [lengthy article on rules][1], but in short,
click on **Cases** up at the top, **Rules** on the left side, and
then the specific event you want to notify on — in our example,
@@ -81,12 +81,12 @@
![](/static/images/integrations/desk/006.png)
1. Select the types of interaction you want your rule to apply to,
1. Select the types of interaction you want your rule to apply to,
such as **Chat**. Specify the name and click on **Add Rule**.
![](/static/images/integrations/desk/007.png)
1. In the next screen, provide the details. First, click **Add Actions**
1. In the next screen, provide the details. First, click **Add Actions**
to display the rule actions. Select **Trigger an App Action** in the
dropdown, and then the name of the custom action you created earlier
when the second dropdown appears. You can add additional **All** or
@@ -95,7 +95,7 @@
![](/static/images/integrations/desk/008.png)
1. Finally, click **Update**.
1. Finally, click **Update**.
{!congrats.md!}

6
zerver/webhooks/helloworld/doc.md
View File

@@ -3,13 +3,13 @@ Learn how Zulip integrations work with this simple Hello World example!
This webhook is Zulip's official [example
integration](/api/incoming-webhooks-walkthrough).
1. The Hello World webhook will use the `test` stream, which is created
1. The Hello World webhook will use the `test` stream, which is created
by default in the Zulip development environment. If you are running
Zulip in production, you should make sure that this stream exists.
1. {!create-bot-construct-url.md!}
1. {!create-bot-construct-url.md!}
1. To trigger a notification using this example webhook, you can use
1. To trigger a notification using this example webhook, you can use
`send_webhook_fixture_message` from a [Zulip development
environment](https://zulip.readthedocs.io/en/latest/development/overview.html):

12
zerver/webhooks/homeassistant/doc.md
View File

@@ -1,21 +1,21 @@
1. {!create-stream.md!}
1. {!create-stream.md!}
1. {!create-an-incoming-webhook.md!}
1. {!create-an-incoming-webhook.md!}
1. In Home Assistant, you need to add the `notify` service to your
1. In Home Assistant, you need to add the `notify` service to your
`configuration.yaml` file. This should look something like this:
![](/static/images/integrations/homeassistant/001.png)
1. The `api_key` parameter should correspond to your bot's key. The `stream`
1. The `api_key` parameter should correspond to your bot's key. The `stream`
parameter is not necessarily required; if not given, it will default to
the `homeassistant` stream.
1. And the URL under `resource` should start with:
1. And the URL under `resource` should start with:
`{{ api_url }}/v1/external/homeassistant`
1. Finally, you need to configure a trigger for the service by adding
1. Finally, you need to configure a trigger for the service by adding
an automation entry in the HomeAssistant `configuration.yaml` file.
![](/static/images/integrations/homeassistant/002.png)

2
zerver/webhooks/json/doc.md
View File

@@ -7,7 +7,7 @@ integration](/api/incoming-webhooks-overview).
1. {!create-bot-construct-url.md!}
1. Configure your application to send the webhook
1. Configure your application to send the webhook
payload to the **URL** generated above.
{!congrats.md!}

12
zerver/webhooks/lidarr/doc.md
View File

@@ -1,21 +1,21 @@
Receive Lidarr notifications in Zulip!
1. {!create-stream.md!}
1. {!create-stream.md!}
1. {!create-bot-construct-url.md!}
1. {!create-bot-construct-url.md!}
1. Go to your Lidarr dashboard. Click **Settings** and
1. Go to your Lidarr dashboard. Click **Settings** and
click **Connect**. Click the **+** icon.
1. Select **Webhook** and set the name of the webhook to any name
1. Select **Webhook** and set the name of the webhook to any name
of your choice (e.g **Zulip**). Select the scenarios you would like
to receive notifications for. You may also enter tags if you would like
to be notified about artists with specific tags.
1. Set **URL** to the **URL** constructed above. Set **Method** to **POST**
1. Set **URL** to the **URL** constructed above. Set **Method** to **POST**
and leave the **Username** and **Password** fields blank.
1. Click **Save** and you should receive a test message.
1. Click **Save** and you should receive a test message.
{!congrats.md!}

6
zerver/webhooks/pingdom/doc.md
View File

@@ -5,16 +5,16 @@ uptime status changes from your Pingdom dashboard.
1. {!create-bot-construct-url.md!}
1. Next, go to the following URL:
1. Next, go to the following URL:
`https://my.pingdom.com/reports/integration/settings`
1. Create your integration by clicking on the **Add Integration** button
1. Create your integration by clicking on the **Add Integration** button
and filling the form like so:
![](/static/images/integrations/pingdom/001.png)
1. Last, during creating or editing your check, scroll down to
1. Last, during creating or editing your check, scroll down to
**Connect Integrations** section and ensure your integration is checked.
{!congrats.md!}

12
zerver/webhooks/radarr/doc.md
View File

@@ -1,21 +1,21 @@
Receive Radarr notifications in Zulip!
1. {!create-stream.md!}
1. {!create-stream.md!}
1. {!create-bot-construct-url.md!}
1. {!create-bot-construct-url.md!}
1. Go to your Radarr dashboard. Click **Settings** and click **Connect**.
1. Go to your Radarr dashboard. Click **Settings** and click **Connect**.
Click the **+** icon.
1. Select **Webhook** and set the name of the webhook to any name of your
1. Select **Webhook** and set the name of the webhook to any name of your
choice (e.g **Zulip**). Select the scenarios you would like to receive
notifications for. You may also enter tags if you would like to be
notified about movies with specific tags.
1. Set **URL** to the **URL** constructed above. Set **Method** to **POST**
1. Set **URL** to the **URL** constructed above. Set **Method** to **POST**
and leave the **Username** and **Password** fields blank.
1. Click **Save** and you should receive a test message.
1. Click **Save** and you should receive a test message.
{!congrats.md!}

4
zerver/webhooks/rundeck/doc.md
View File

@@ -1,8 +1,8 @@
Receive Job Notifications in Zulip!
1. {!create-stream.md!}
1. {!create-stream.md!}
1. {!create-bot-construct-url.md!}
1. {!create-bot-construct-url.md!}
1. Go to your Rundeck web interface and click on the desired job.
Click on **Actions** and then select **Edit this Job...**.

12
zerver/webhooks/sonarr/doc.md
View File

@@ -1,21 +1,21 @@
Receive Sonarr notifications in Zulip!
1. {!create-stream.md!}
1. {!create-stream.md!}
1. {!create-bot-construct-url.md!}
1. {!create-bot-construct-url.md!}
1. Go to your Sonarr dashboard. Click **Settings** and click **Connect**.
1. Go to your Sonarr dashboard. Click **Settings** and click **Connect**.
Click the **+** icon.
1. Select **Webhook** and set the name of the webhook to any name of your
1. Select **Webhook** and set the name of the webhook to any name of your
choice (e.g **Zulip**). Select the scenarios you would like to receive
notifications for. You may also enter tags if you would like to be
notified about series with specific tags.
1. Set **URL** to the **URL** constructed above. Set **Method** to **POST**
1. Set **URL** to the **URL** constructed above. Set **Method** to **POST**
and leave the **Username** and **Password** fields blank.
1. Click **Save** and you should receive a test message.
1. Click **Save** and you should receive a test message.
{!congrats.md!}

2
zerver/webhooks/trello/doc.md
View File

@@ -28,7 +28,7 @@ Get Zulip notifications from your Trello boards!
computer (any computer) connected to the internet. It won't make any
changes to the computer.
1. Make sure you have a working copy of Python. If you're running
1. Make sure you have a working copy of Python. If you're running
macOS or Linux, you very likely already do. If you're running
Windows you may or may not. If you don't have Python, follow the
installation instructions

22
zerver/webhooks/zendesk/doc.md
View File

@@ -1,21 +1,21 @@
1. {!create-stream.md!}
1. {!create-stream.md!}
1. {!create-an-incoming-webhook.md!}
1. {!create-an-incoming-webhook.md!}
1. Construct a webhook URL like the following:
1. Construct a webhook URL like the following:
`{{ api_url }}/v1/external/zendesk?ticket_title={% raw %}{{ ticket.title }}&ticket_id={{ ticket.id }}{% endraw %}`
1. {!append-stream-name.md!}
1. {!append-stream-name.md!}
1. Next, in Zendesk, open your **Admin** view via gear in the bottom-left
1. Next, in Zendesk, open your **Admin** view via gear in the bottom-left
corner. In the **Admin** view, click on **Extensions**, then click
**add target**.
![](/static/images/integrations/zendesk/001.png)
![](/static/images/integrations/zendesk/002.png)
1. From there, click **URL target**. Fill in the form like this:
1. From there, click **URL target**. Fill in the form like this:
* **Title**: Zulip
* **URL**: the URL we created above
@@ -26,11 +26,11 @@
![](/static/images/integrations/zendesk/003.png)
1. Now, select **Test Target** and click **Submit**. A test message should
1. Now, select **Test Target** and click **Submit**. A test message should
appear in the `zendesk` stream. If the message was received, save the
target by selecting **Create target** and clicking **Submit**.
1. From here, add a new trigger. You'll do this for every action you want
1. From here, add a new trigger. You'll do this for every action you want
to create a Zulip notification for. Triggers are added by selecting
**Triggers** in the left menu and then clicking **add trigger** in the
top right.
@@ -38,13 +38,13 @@
![](/static/images/integrations/zendesk/004.png)
![](/static/images/integrations/zendesk/005.png)
1. Let's say you want a notification each time a ticket is updated. Put
1. Let's say you want a notification each time a ticket is updated. Put
in a descriptive title like "Announce ticket update". Under **Meet all of
the following conditions** select **Ticket: is...** and then select
**Updated**. In the **Perform these actions** section, select
**Notification: Notify target**, then select **Zulip**.
1. Next we need to enter the message body into Message. You can use
1. Next we need to enter the message body into Message. You can use
Zulip Markdown and the Zendesk placeholders when creating your message.
You can copy this example template:
@@ -64,7 +64,7 @@
![](/static/images/integrations/zendesk/006.png)
1. Finally, click **Submit**.
1. Finally, click **Submit**.
{!congrats.md!}