Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api docs: Update non-webhook-integrations.md. 

Addresses comments on a8e1225.
This commit is contained in:
Rishi Gupta 2018-10-20 09:19:26 -07:00
parent e0c6f62618
commit 796a1a6582
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
templates/zerver/api/non-webhook-integrations.md
View File

@ -1,8 +1,8 @@
# Non-webhook integrations # Non-webhook integrations
Incoming webhook integrations are the fastest to write, but sometimes a [Incoming webhook integrations](/api/incoming-webhooks-overview) are the
third-party product just doesn't support them. Zulip supports two other fastest to write, but sometimes a third-party product just doesn't support
types of integrations. them. Zulip supports several other types of integrations.
1. **Python script integrations** 1. **Python script integrations**
(examples: SVN, Git), where we can get the service to call our integration (examples: SVN, Git), where we can get the service to call our integration
@ -20,12 +20,14 @@ types of integrations.
documentation for the third party software in order to learn how to documentation for the third party software in order to learn how to
write the integration. write the integration.
1. **Interactive bots**. See [Writing bots](/api/writing-bots).
A few notes on how to do these: A few notes on how to do these:
* You should always send messages by POSTing to URLs of the form * You should always send messages by POSTing to URLs of the form
`https://zulip.example.com/v1/messages/`. `https://zulip.example.com/v1/messages/`.
* We usually build Python script integration with (at least) 2 files: * We usually build Python script integrations with (at least) 2 files:
`zulip_foo_config.py` containing the configuration for the `zulip_foo_config.py` containing the configuration for the
integration including the bots' API keys, plus a script that reads integration including the bots' API keys, plus a script that reads
from this configuration to actually do the work (that way, it's from this configuration to actually do the work (that way, it's