paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 21:43:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

webhooks/zendesk: Migrate docs to Markdown.

Browse Source
This commit is contained in:
Eeshan Garg
2017-06-14 02:23:08 -02:30
committed by Tim Abbott
parent 9e77749bfc
commit 2344e26b1a
2 changed files with 74 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
zerver/webhooks/zendesk/doc.html
View File

@@ -1,81 +0,0 @@
<p>
First, create the stream you'd like to use for Zendesk notifications,
and subscribe all interested parties to this stream. We recommend the
stream name <code>zendesk</code>. Keep in mind you still need to create
the stream first even if you are using this recommendation.
</p>
<p>
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".
</p>
<img class="screenshot" src="/static/images/integrations/zendesk/001.png"/>
<img class="screenshot" src="/static/images/integrations/zendesk/002.png"/>
<p>From there, click "URL target". Fill in the form like this:</p>
<ul>
<li><b>Title</b>: Zulip</li>
<li><b>URL</b>:
<code>{{ external_api_uri_subdomain }}{% raw %}/v1/external/zendesk?ticket_title={{ ticket.title }}&amp;ticket_id={{ ticket.id }}&amp;stream=zendesk{% endraw %}</code>
</li>
<li><b>Method</b>: POST</li>
<li><b>Attribute Name</b>: message</li>
<li><b>Username</b>: <em>your bot's user name, e.g.</em> <code>zendesk-bot@yourdomain.com</code></li>
<li><b>Password</b>: <em>your bot's API key</em></li>
</ul>
<img class="screenshot" src="/static/images/integrations/zendesk/003.png"/>
<p>
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.
</p>
<p>
From here, add a new trigger. You'll do this for every action you want
to create a Zulip notification. Triggers are added by selecting Triggers
in the left menu and then clicking "add trigger" in the top right.
</p>
<img class="screenshot" src="/static/images/integrations/zendesk/004.png"/>
<img class="screenshot" src="/static/images/integrations/zendesk/005.png"/>
<p>
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 folllowing conditions" select "Ticket: is..." and then select
Updated. In the "Perform these actions" section select "Notification:
Notify target" then select Zulip.
</p>
<p>
Next we need 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:
</p>
{% raw %}
<pre><code>Ticket [#{{ ticket.id }}: {{ ticket.title }}]({{ ticket.link }}), was updated by {{ current_user.name }}
* Status: {{ ticket.status }}
* Priority: {{ ticket.priority }}
* Type: {{ ticket.ticket_type }}
* Assignee: {{ ticket.assignee.name }}
* Tags: {{ ticket.tags }}
* Description:
``` quote
{{ ticket.description }}
```</code></pre>
{% endraw %}
<img src="/static/images/integrations/zendesk/006.png"/>
<p>Finally, click Submit.</p>
<p>
<b>Congratulations! You're Done!</b><br/> When a ticket is updated
you will see a notification like the following, to the stream
<code>zendesk</code>, with a topic that matches the ticket's subject
name:
</p>
<img class="screenshot" src="/static/images/integrations/zendesk/007.png"/>

74
zerver/webhooks/zendesk/doc.md Normal file
View File

@@ -0,0 +1,74 @@
{!create-stream.md!}
Next, on your {{ settings_html|safe }}, create a bot.
Construct a webhook URL like the following:
`{{ external_api_uri_subdomain }}/v1/external/zendesk?ticket_title={% raw %}{{ ticket.title }}&ticket_id={{ ticket.id }}{% endraw %}`
{!append-stream-name.md!}
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)
From there, click **URL target**. Fill in the form like this:
* **Title**: Zulip
* **URL**: the URL we created above
* **Method**: POST
* **Attribute Name**: message
* **Username**: *your bot's user name, e.g.* `zendesk-bot@yourdomain.com`
* **Password**: *your bot's API key*
![](/static/images/integrations/zendesk/003.png)
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**.
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.
![](/static/images/integrations/zendesk/004.png)
![](/static/images/integrations/zendesk/005.png)
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 folllowing conditions** select **Ticket: is...** and then select
**Updated**. In the **Perform these actions** section, select
**Notification: Notify target**, then select **Zulip**.
Next we need 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:
</p>
{% raw %}
~~~
Ticket [#{{ ticket.id }}: {{ ticket.title }}]({{ ticket.link }}), was updated by {{ current_user.name }}
* Status: {{ ticket.status }}
* Priority: {{ ticket.priority }}
* Type: {{ ticket.ticket_type }}
* Assignee: {{ ticket.assignee.name }}
* Tags: {{ ticket.tags }}
* Description:
``` quote
{{ ticket.description }}
```
~~~
{% endraw %}
![](/static/images/integrations/zendesk/006.png)
Finally, click **Submit**.
{!congrats.md!}
![](/static/images/integrations/zendesk/007.png)