Files
zulip/zerver/webhooks/yo/doc.md
Greg Price eb55a3a1ba template context: Give better names to the URLs for the API.
The "subdomain" label is redundant, to the extent it's even
accurate -- this is really just the URL we want to display,
which may or may not involve a subdomain.  Similarly "external".

The former `external_api_path_subdomain` was never a path -- it's a
host, followed by a path, which together form a scheme-relative URL.
I'm not quite convinced that value is actually the right thing in
2 of the 3 places we use it, but fixing that can start by giving an
accurate name to the thing we have.
2017-10-30 18:29:29 -07:00

29 lines
944 B
Markdown

See your Yo App notifications in Zulip!
First, on your {{ settings_html|safe }}, create a bot for
{{ integration_display_name }}. Construct the URL for the
{{ integration_display_name }} bot using the bot API key
and the email address associated with your Zulip account:
`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&email=awesome@zulip.example.com`
Modify the parameters of the URL above, where `api_key` is the API key
of your Zulip bot.
You will receive your notifications as a private message from the bot.
Copy the URL created and go to <https://yoapi.justyo.co>.
Sign in using your username and password and go to **Edit Profile**.
![](/static/images/integrations/yo-app/001.png)
Paste the URL in the **Callback** field and click on **Update**.
{!congrats.md!}
![](/static/images/integrations/yo-app/002.png)
Multiple users can use the same Yo bot; each user should use
their own Zulip account email in the webhook URL.