Skip to content

Commit

Permalink
Merge pull request #187 from Tournesol-me/update_webhook_doc
Browse files Browse the repository at this point in the history
Update webhook doc
  • Loading branch information
gabek authored Nov 2, 2024
2 parents 5b15e4d + ae44fa6 commit 22251e5
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions content/thirdparty/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,16 @@ Note: the field `user` in the chat was introduced with `v0.0.8`. Before `v0.0.8`
"eventData": {
"id": "DmeikEf4Rz",
"name": "New Owncast Server",
"status": {
"lastConnectTime": null,
"lastDisconnectTime": "2024-10-24T22:35:05Z",
"versionNumber": "0.1.3",
"streamTitle": "Test stream title change",
"viewerCount": 0,
"overallMaxViewerCount": 7,
"sessionMaxViewerCount": 2,
"online": false
},
"streamTitle": "Test stream title change",
"summary": "This is a new live video streaming server powered by Owncast.",
"timestamp": "2023-03-27T21:50:10.121391094-07:00"
Expand All @@ -185,17 +195,16 @@ Note: the field `user` in the chat was introduced with `v0.0.8`. Before `v0.0.8`
"type": "VISIBILITY-UPDATE",
"eventData": {
"id": "zqGupt7VR",
"ids": [
"MessageIDs": [
"-Zzltt74g",
"rvd2ppn4g"
],
"timestamp": "2022-09-19T12:44:28.225779601+02:00",
"type": "VISIBILITY-UPDATE",
"visible": false
"Visible": false
}
}
```
- `ids` is a list of IDs of messages that had their visibility changed.
- `MessageIDs` is a list of IDs of messages that had their visibility changed.

### clientId vs. user.id

Expand All @@ -222,4 +231,4 @@ If you want to test how webhooks work before you write any code, create a test e

### Test webhooks from a production instance of Owncast

If you already have an Owncast instance running in production, listening to the world wide web, you might want to make use [ngrok](https://ngrok.com/) to tunnel HTTP requests to your local development environment.
If you already have an Owncast instance running in production, listening to the world wide web, you might want to make use [ngrok](https://ngrok.com/) to tunnel HTTP requests to your local development environment.

0 comments on commit 22251e5

Please sign in to comment.