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

template context: Give better names to the URLs for the API.

Browse Source 
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.
This commit is contained in:
Greg Price
2017-10-30 14:04:15 -07:00
parent 271a9f0da7
commit eb55a3a1ba
26 changed files with 53 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -31,7 +31,7 @@ parts.
4. In the **Action** section, add a new action of type **Trigger Webhook**.
Set the **Request Type** to **POST**. Set the following **Callback URL**,
replacing the Zulip stream with your desired stream:
`{{ external_api_uri_subdomain }}/v1/external/freshdesk?stream=freshdesk`
`{{ api_url }}/v1/external/freshdesk?stream=freshdesk`
5. Check the **Requires Authentication** box, and supply the bot email
address and API key. The **Action** section should look like this so
@@ -103,7 +103,7 @@ changes, please continue to the next section.
**Trigger Webhook**. Set the **Request Type** to **POST**. Set the
following **Callback URL**, replacing the Zulip stream with your
desired stream:
`{{ external_api_uri_subdomain }}/v1/external/freshdesk?stream=freshdesk`
`{{ api_url }}/v1/external/freshdesk?stream=freshdesk`
8. Check the **Requires Authentication** box, and supply the bot e-mail
address and API key. The Action section should look like this so far: