mirror of https://github.com/zulip/zulip.git
webhooks/jira: Update docs to conform to style guide.
I spend a lot of time on this. One of our users had reported that this webhook wasn't working at all. So I tested this with a local ngrok instance and made sure that it was working. I also took this opportunity to rewrite the docs for this, which were quite outdated. With a few changes by Rishi Gupta!
This commit is contained in:
parent
47aaf4e20a
commit
9157b217f0
|
@ -1,20 +1,23 @@
|
||||||
*If you are running JIRA version 5.2 or greater, or if you are
|
Get Zulip notifications for your JIRA projects!
|
||||||
using the hosted JIRA provided by Atlassian, you can use the built-in
|
|
||||||
web-hook support to connect to Zulip — read on. For older,
|
|
||||||
self-hosted JIRA installs, you can use our [JIRA Plugin](./jira-plugin).*
|
|
||||||
|
|
||||||
{!create-stream.md!}
|
These instructions apply to Atlassian Cloud's hosted JIRA, and JIRA Server version
|
||||||
|
5.2 or greater. For older installs, you'll need our [JIRA Plugin](./jira-plugin).
|
||||||
|
|
||||||
{!create-bot-construct-url.md!}
|
1. {!create-stream.md!}
|
||||||
|
|
||||||
Next, in your JIRA administration control panel, go to the **Webhooks**
|
1. {!create-bot-construct-url-indented.md!}
|
||||||
page. If you are using the OnDemand hosted JIRA, follow the instructions
|
|
||||||
[on the Atlassian wiki][1] for locating the Webhook UI.
|
|
||||||
|
|
||||||
[1]: https://developer.atlassian.com/jiradev/jira-apis/webhooks#Webhooks-jiraadmin
|
1. Go to your JIRA **Site administration** page. Click **Jira** on the left.
|
||||||
|
On the left sidebar, scroll down, and under **Advanced**, click **WebHooks**.
|
||||||
|
Click **+ Create a WebHook**.
|
||||||
|
|
||||||
Give your new webhook a name, and for the URL provide the URL we
|
1. Set **Name** to a name of your choice, such as `Zulip`. Set **Status** to
|
||||||
created above.
|
**Enabled**, and set **URL** to the URL constructed above. Select the events
|
||||||
|
you'd like to be notified about, and click **Create**. We
|
||||||
|
support the following events:
|
||||||
|
* when an issue is created
|
||||||
|
* when an issue is deleted
|
||||||
|
* when an issue is updated
|
||||||
|
|
||||||
{!congrats.md!}
|
{!congrats.md!}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue