Matrix-Mirrors/matrix-dimension
1
0
Fork 0
mirror of https://github.com/turt2live/matrix-dimension.git synced 2024-10-01 05:05:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Scalar documentation for the Gitter bridge

Browse Source
This commit is contained in:
Travis Ralston 2018-10-21 13:00:33 -06:00
parent af095cd801
commit 909927edab
1 changed files with 89 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
docs/reference/scalar_server_api.md
View File

@ -322,6 +322,95 @@ None of these are officially documented, and are subject to change.
}
```
## POST `/api/bridges/gitter/_matrix/provision/getlink/?scalar_token=...`
**Body**
```
{
"matrix_room_id": "!JmvocvDuPTYUfuvKgs:t2l.io"
}
```
**Response**
```
{
"replies": [{
"rid": "...",
"response":{
"matrix_room_id": "!JmvocvDuPTYUfuvKgs:t2l.io",
"remote_room_name": "t2bot-io/Testing"
}
}]
}
```
*Note*: This API is polled to check for updates, such as bridging success. This will also 404 if there is no link.
## POST `/api/bridges/gitter/_matrix/provision/unlink?scalar_token=...`
**Body**
```
{
"matrix_room_id": "!JmvocvDuPTYUfuvKgs:t2l.io",
"remote_room_name": "t2bot-io/Testing"
}
```
**Response**
```
{
"replies": [
{
"rid": "..",
"response": {}
}
]
}
```
## POST `/api/bridges/gitter/_matrix/provision/getbotid?scalar_token=...`
**Body**
```
{}
```
**Response**
```
{
"replies": [
{
"rid": "..",
"response": {
"bot_user_id": "@gitterbot:matrix.org"
}
}
]
}
```
## POST `/api/bridges/gitter/_matrix/provision/link?scalar_token=...`
**Body**
```
{
"matrix_room_id": "!JmvocvDuPTYUfuvKgs:t2l.io",
"remote_room_name": "t2bot-io/Testing"
}
```
**Response**
```
{
"replies": [
{
"rid": "..",
"response": {}
}
]
}
```
## POST `/api/integrations/github-webhook?scalar_token=...`
**Body**