webhook

Documentation

Index

• Constants
• Variables
• func Receive(r *http.Request, provider auth.KeyProvider) ([]byte, error)
• func ReceiveWebhookEvent(r *http.Request, provider auth.KeyProvider) (*livekit.WebhookEvent, error)
• type DefaultNotifier
  • func (n *DefaultNotifier) QueueNotify(ctx context.Context, event *livekit.WebhookEvent) error
  • func (n *DefaultNotifier) RegisterProcessedHook(hook func(ctx context.Context, whi *livekit.WebhookInfo))
  • func (n *DefaultNotifier) Stop(force bool)
• type HTTPClientParams
• type QueuedNotifier
  • func NewDefaultNotifier(apiKey, apiSecret string, urls []string) QueuedNotifier
• type URLNotifier
  • func NewURLNotifier(params URLNotifierParams) *URLNotifier
  • func (n *URLNotifier) QueueNotify(ctx context.Context, event *livekit.WebhookEvent) error
  • func (n *URLNotifier) RegisterProcessedHook(hook func(ctx context.Context, whi *livekit.WebhookInfo))
  • func (n *URLNotifier) SetKeys(apiKey, apiSecret string)
  • func (n *URLNotifier) Stop(force bool)
• type URLNotifierParams

Constants

const (
	EventRoomStarted       = "room_started"
	EventRoomFinished      = "room_finished"
	EventParticipantJoined = "participant_joined"
	EventParticipantLeft   = "participant_left"
	EventTrackPublished    = "track_published"
	EventTrackUnpublished  = "track_unpublished"
	EventEgressStarted     = "egress_started"
	EventEgressUpdated     = "egress_updated"
	EventEgressEnded       = "egress_ended"
	EventIngressStarted    = "ingress_started"
	EventIngressEnded      = "ingress_ended"
)

Variables

var (
	ErrNoAuthHeader    = errors.New("authorization header could not be found")
	ErrSecretNotFound  = errors.New("API secret could not be found")
	ErrInvalidChecksum = errors.New("could not verify authenticity of message")
)

Functions

func Receive

func Receive(r *http.Request, provider auth.KeyProvider) ([]byte, error)

Receive reads and verifies incoming webhook is signed with key/secret pair closes body after reading

func ReceiveWebhookEvent

func ReceiveWebhookEvent(r *http.Request, provider auth.KeyProvider) (*livekit.WebhookEvent, error)

ReceiveWebhookEvent reads and verifies incoming webhook, and returns a parsed WebhookEvent

Types

type DefaultNotifier

type DefaultNotifier struct {
	// contains filtered or unexported fields
}

func (*DefaultNotifier) QueueNotify

func (n *DefaultNotifier) QueueNotify(ctx context.Context, event *livekit.WebhookEvent) error

func (*DefaultNotifier) RegisterProcessedHook

func (n *DefaultNotifier) RegisterProcessedHook(hook func(ctx context.Context, whi *livekit.WebhookInfo))

func (*DefaultNotifier) Stop

func (n *DefaultNotifier) Stop(force bool)

type HTTPClientParams

type HTTPClientParams struct {
	RetryWaitMin  time.Duration
	RetryWaitMax  time.Duration
	MaxRetries    int
	ClientTimeout time.Duration
}

type QueuedNotifier

type QueuedNotifier interface {
	RegisterProcessedHook(f func(ctx context.Context, whi *livekit.WebhookInfo))
	QueueNotify(ctx context.Context, event *livekit.WebhookEvent) error
}

func NewDefaultNotifier

func NewDefaultNotifier(apiKey, apiSecret string, urls []string) QueuedNotifier

type URLNotifier

type URLNotifier struct {
	// contains filtered or unexported fields
}

URLNotifier is a QueuedNotifier that sends a POST request to a Webhook URL. It will retry on failure, and will drop events if notification fall too far behind

func NewURLNotifier

func NewURLNotifier(params URLNotifierParams) *URLNotifier

func (*URLNotifier) QueueNotify

func (n *URLNotifier) QueueNotify(ctx context.Context, event *livekit.WebhookEvent) error

func (*URLNotifier) RegisterProcessedHook

func (n *URLNotifier) RegisterProcessedHook(hook func(ctx context.Context, whi *livekit.WebhookInfo))

func (*URLNotifier) SetKeys

func (n *URLNotifier) SetKeys(apiKey, apiSecret string)

func (*URLNotifier) Stop

func (n *URLNotifier) Stop(force bool)

type URLNotifierParams

type URLNotifierParams struct {
	HTTPClientParams
	Logger     logger.Logger
	QueueSize  int
	URL        string
	APIKey     string
	APISecret  string
	FieldsHook func(whi *livekit.WebhookInfo)
}