protocol

Documentation

Index

• type AuthMsg
• type AuthResult
• type Envelope
• type EventMsg
• type StatusMsg
• type SubscribeMsg

Types

type AuthMsg

type AuthMsg struct {
	MsgType  string `json:"MsgType"`
	Token    string `json:"Token"`
	ClientID string `json:"ClientID"`
}

AuthMsg sent by client on connect.

type AuthResult

type AuthResult struct {
	MsgType string `json:"MsgType"`
	Reason  string `json:"Reason,omitempty"`
}

AuthResult sent by server after auth.

type Envelope

type Envelope struct {
	MsgType string          `json:"MsgType"`
	Data    json.RawMessage `json:"Data,omitempty"`
}

Envelope wraps all WebSocket messages with a MsgType for routing.

type EventMsg

type EventMsg struct {
	MsgType        string            `json:"MsgType"`
	DeliveryID     string            `json:"DeliveryID"`
	GitHubEvent    string            `json:"GitHubEvent"`
	Provider       string            `json:"Provider,omitempty"`
	StableEvent    string            `json:"StableEvent,omitempty"`
	ExternalEvent  string            `json:"ExternalEvent,omitempty"`
	ExternalAction string            `json:"ExternalAction,omitempty"`
	Repo           string            `json:"Repo"`
	Ref            string            `json:"Ref,omitempty"`
	Action         string            `json:"Action,omitempty"`
	Sender         string            `json:"Sender,omitempty"`
	Message        string            `json:"Message,omitempty"`
	CloneURL       string            `json:"CloneURL"`
	PRNumber       int               `json:"PRNumber,omitempty"`
	Headers        map[string]string `json:"Headers,omitempty"`
	Metadata       map[string]string `json:"Metadata,omitempty"`
	Payload        json.RawMessage   `json:"Payload"`
}

EventMsg sent by server to client when a webhook arrives.

type StatusMsg

type StatusMsg struct {
	MsgType     string `json:"MsgType"`
	DeliveryID  string `json:"DeliveryID"`
	State       string `json:"State"`
	Description string `json:"Description,omitempty"`
}

StatusMsg sent by client after processing an event.

type SubscribeMsg

type SubscribeMsg struct {
	MsgType  string   `json:"MsgType"`
	Patterns []string `json:"Patterns"`
}

SubscribeMsg sent by client after auth.