Build on top of Owncast

Owncast has the ability for you to build things on top of it. Here’s some examples of things you can build:

  1. A chat bot that replies to keywords or commands.
  2. An OBS overlay so when an event happens in the chat an image or message shows up on the stream.
  3. An integration into some kind of 3rd party service, such as when the song you’re listening to changes it shows up in the chat.
  4. Send out a message to your social networks each time you go live.

Your code

  1. In any language, on any kind of web server, create an endpoint that accepts a HTTP POST request. This is where Owncast will be sending events.
  2. Each event payload will have a type property that states what of the above events are included, and an eventData object that includes all the specific properties of this event.
  3. If you need a starting point see our example projects.

Functionality

You have the ability to get notified when certain actions take place on your Owncast server via webhooks and are able to send actions into your server via specific APIs secured by access tokens.

Tools

The following are some tools that might make building a bit easier.

Development environment

You can host your software anywhere and write it in any language.

A quick, easy and free way to get up and running to experiment is by using Glitch. You can create a free account and write a Node.js application that can accept webhooks and send requests to your Owncast server. You can edit code right in the browser and it’s immediately available to the world. You can always move your code to another server when you’re done if you don’t want to keep it on Glitch.

APIs & Access Tokens →
Learn about access tokens and APIs
Webhooks →
Webhooks description
Sample Projects →
Some sample code and example projects.