owncast/models/webhook.go

package models

import (
	"time"

	"github.com/owncast/owncast/utils"
)

// Webhook is an event that is sent to 3rd party, external services with details about something that took place within an Owncast server.
type Webhook struct {
	Timestamp time.Time   `json:"timestamp"`
	LastUsed  *time.Time  `json:"lastUsed"`
	URL       string      `json:"url"`
	Events    []EventType `json:"events"`
	ID        int         `json:"id"`
}

// For an event to be seen as "valid" it must live in this slice.
var validEvents = []EventType{
	MessageSent,
	UserJoined,
	UserParted,
	UserNameChanged,
	VisibiltyToggled,
	StreamStarted,
	StreamStopped,
	StreamTitleUpdated,
}

// HasValidEvents will verify that all the events provided are valid.
// This is not a efficient method.
func HasValidEvents(events []EventType) bool {
	for _, event := range events {
		if _, foundInSlice := utils.FindInSlice(validEvents, event); !foundInSlice {
			return false
		}
	}
	return true
}