CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-18 21:01:52 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

integration guide: Swap created files above updated files.

Browse Source
This commit is contained in:
Tim Abbott 2016-08-04 11:53:05 -07:00
parent 0691832817
commit 613781f034
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/integration-guide.md
View File

@ -116,19 +116,6 @@ Here's how we recommend doing it:
* Finally, write documentation for the integration; there's a
[detailed guide](#documenting-your-integration) below.
### Files that need to be updated
* `templates/zerver/integrations.html`: Edit to add end-user documentation and
integration icon. See [Documenting your
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.
* `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
Select a name for your webhook and use it consistently. The examples below are
@ -148,6 +135,19 @@ for a webhook named 'MyWebHook'.
* `zerver/views/webhooks/mywebhook.py`: Includes the main webhook integration
function including any needed helper functions.
### Files that need to be updated
* `templates/zerver/integrations.html`: Edit to add end-user documentation and
integration icon. See [Documenting your
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.
* `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`.
### Walkthrough of `Hello World` webhook
Below explains each part of a simple webhook integration, called **Hello