paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document new WEBHOOK_INTEGRATIONS API.

Browse Source
This commit is contained in:
Tim Abbott
2016-08-04 11:52:28 -07:00
parent 5f37485e7f
commit 0691832817
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/integration-guide.md
View File

@@ -123,8 +123,11 @@ Here's how we recommend doing it:
integration](#documenting-your-integration) for details.
* `zerver/test_hooks.py`: Edit to include tests for your webbook. See [Testing
and writing tests](testing.html) for details.
* `zproject/urls.py`: Edit to add externally available url of the webhook and
associate with the function added to `zerver/views/webhooks/mywebhook.py`
* `zerver/lib/integrations.py`: Add your integration to
`WEBHOOK_INTEGRATIONS` to register it. This will automatically
register a url for the webhook of the form `api/v1/external/mywebhook`
and associate with the function called `api_mywebhook_webhook` in
`zerver/views/webhooks/mywebhook.py`.
### Files that need to be created