owncast-webhook/README.md
Simon Vieille 8ba80fe469
Some checks are pending
ci/woodpecker/push/build Pipeline is pending approval
update readme
2025-08-29 14:55:29 +02:00

1,016 B

Owncast webhook server and chat aggregator

This project provides a webhook server for Owncast.

It implements the webhook triggered when a new message is posted in the chat. It also allows retrieving messages from a Twitch channel and displaying them together on a page that can be embedded into OBS.

Installation

Pre-compiled package

Go to releases and download the latest owncast-webhook.

From source

Requirements: nodejs (tested with >=22), golang (tested with >=1.24)

git clone https://gitnet.fr/deblan/owncast-webhook
npm i
make build

Configuration

Server side

cp config.ini.example config.ini

Owncast

Add a webhook (Integration > Webhooks):

  • URL: {server.base_url}/webhook/{server.webhook_secret}/owncast/chat_message
  • Events: When a user sends a chat message

OBS

You can embed the chat using this URL: {server.base_url}/chat/messages

Usage

./owncast-webhook -c ./config.ini