mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 13:33:24 +00:00
integrations: Update deskdotcom integration docs.
I have updated the documentation for the deskdotcom integration to include numbers for ease of readability. Fixes part of #17633.
This commit is contained in:
Adam Birds
Tim Abbott
@@ -1,104 +1,102 @@
|
||||
{!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.
|
||||
Keep in mind you still need to create the stream first even
|
||||
if you are using this recommendation.
|
||||
|
||||
Next, on your {{ settings_html|safe }}, create a bot and
|
||||
note its email and API key.
|
||||
1. Next, on your {{ settings_html|safe }}, create a bot and
|
||||
note its email and API key.
|
||||
|
||||
Next, in Desk.com, open your **Admin** view via the top-left
|
||||
corner dropdown. In the **Admin** view, click on **Apps**, then
|
||||
click **Install** under **Custom Action**:
|
||||
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**:
|
||||
|
||||
|
||||
|
||||
|
||||
From there, click **Install Custom Action** and accept the terms.
|
||||
Fill in the form like this:
|
||||
1. From there, click **Install Custom Action** and accept the terms.
|
||||
Fill in the form like this:
|
||||
|
||||
* **Name**: Zulip
|
||||
* **Authentication Method**: Basic Auth
|
||||
* **URL**: `{{ api_url }}/v1/external/deskdotcom`
|
||||
* **User name**: *your bot's user name, e.g.* `desk-bot@yourdomain.com`
|
||||
* **Password**: *your bot's API key*
|
||||
* **Name**: Zulip
|
||||
* **Authentication Method**: Basic Auth
|
||||
* **URL**: `{{ api_url }}/v1/external/deskdotcom`
|
||||
* **User name**: *your bot's user name, e.g.* `desk-bot@yourdomain.com`
|
||||
* **Password**: *your bot's API key*
|
||||
|
||||
|
||||
|
||||
|
||||
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
|
||||
**Installed Apps.**
|
||||
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
|
||||
**Installed Apps.**
|
||||
|
||||
|
||||
|
||||
|
||||
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**:
|
||||
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**:
|
||||
|
||||
{% raw %}
|
||||
{% raw %}
|
||||
|
||||
`?stream=desk&topic={{ case.id }}:+{{ case.subject }}`
|
||||
`?stream=desk&topic={{ case.id }}:+{{ case.subject }}`
|
||||
|
||||
{% endraw %}
|
||||
{% endraw %}
|
||||
|
||||
The "appended URL path" will be the same for every notification —
|
||||
it makes sure the notification goes to the appropriate stream and topic
|
||||
within Zulip.
|
||||
The "appended URL path" will be the same for every notification —
|
||||
it makes sure the notification goes to the appropriate stream and topic
|
||||
within Zulip.
|
||||
|
||||
Next, copy this template Zulip message into **Message to POST**:
|
||||
1. Next, copy this template Zulip message into **Message to POST**:
|
||||
|
||||
{% raw %}
|
||||
{% raw %}
|
||||
|
||||
```
|
||||
Case [{{ case.id }}, {{ case.subject }}]({{ case.direct_url }}), was updated.
|
||||
Case [{{ case.id }}, {{ case.subject }}]({{ case.direct_url }}), was updated.
|
||||
|
||||
* Status: {{ case.status.name }}
|
||||
* Priority: {{ case.priority }}
|
||||
* Customer: {{ customer.name }}
|
||||
* Company: {{ customer.company }}
|
||||
* Description: {{ case.description }}
|
||||
```
|
||||
* Status: {{ case.status.name }}
|
||||
* Priority: {{ case.priority }}
|
||||
* Customer: {{ customer.name }}
|
||||
* Company: {{ customer.company }}
|
||||
* Description: {{ case.description }}
|
||||
|
||||
{% endraw %}
|
||||
{% endraw %}
|
||||
|
||||
You don't need to edit that, although you may if you wish. All the
|
||||
funny-looking stuff inside `{{ "{{" }}` and `{{ "}}" }}` will be filled in by
|
||||
Desk.com for each event. The dialog should look like this:
|
||||
You don't need to edit that, although you may if you wish. All the
|
||||
funny-looking stuff inside `{{ "{{" }}` and `{{ "}}" }}` will be filled in by
|
||||
Desk.com for each event. The dialog should look like this:
|
||||
|
||||
|
||||
|
||||
|
||||
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!
|
||||
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!
|
||||
|
||||
|
||||
|
||||
|
||||
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,
|
||||
**Inbound Interaction**.
|
||||
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,
|
||||
**Inbound Interaction**.
|
||||
|
||||
[1]: https://support.desk.com/customer/portal/articles/1376
|
||||
[1]: https://support.desk.com/customer/portal/articles/1376
|
||||
|
||||
|
||||
|
||||
|
||||
Select the types of interaction you want your rule to apply to,
|
||||
such as **Chat**. Specify the name and click on **Add Rule**.
|
||||
1. Select the types of interaction you want your rule to apply to,
|
||||
such as **Chat**. Specify the name and click on **Add Rule**.
|
||||
|
||||
|
||||
|
||||
|
||||
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
|
||||
**Any** conditions if desired. Also select when the rule should run
|
||||
(if not **Anytime**) and enable it.
|
||||
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
|
||||
**Any** conditions if desired. Also select when the rule should run
|
||||
(if not **Anytime**) and enable it.
|
||||
|
||||
|
||||
|
||||
|
||||
Finally, click **Update**.
|
||||
1. Finally, click **Update**.
|
||||
|
||||
{!congrats.md!}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user