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

outgoing-webhooks.md: Document example endpoint responses.

This commit is contained in:
Eeshan Garg 2018-09-10 19:46:34 -02:30 committed by Tim Abbott
parent 10570d508f
commit 5c8b774628
1 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
templates/zerver/api/outgoing-webhooks.md
View File

@ -109,15 +109,38 @@ is helpful to distinguish deliberate non-responses from bugs.)
### Example incoming payload
This is an example of the JSON payload that the Zulip server will `POST`
to your server:
{generate_code_example|zulip-outgoing-webhook-payload|fixture}
### Example response payloads
Here's an example of the JSON your server should respond with if
you would not like to send a response message:
```
{
"response_not_required": true
}
```
Here's an example of the JSON your server should respond with if
you would like to send a response message:
```
{
"content": "Hey, we just received something from Zulip!"
}
```
## Slack-format webhook format
This interface translates the Zulip's outgoing webhook's request into
Slack's outgoing webhook request. Hence the outgoing webhook bot
would be able to post data to URLs which support Slack's outgoing
webhooks. Here's how we fill in the fields that a Slack format
webhook expects:
This interface translates Zulip's outgoing webhook's request into
the format that Slack expects. Hence the outgoing webhook bot
would be able to post data to URLs which support Slack-style
webhook payloads. Here's how we fill in the fields that a
Slack-format webhook expects:
<table class="table">
<thead>