Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

githubapp

package

Go to main page

Versions in this module

v0

v0.2.1

Oct 19, 2026

Changes in this version

+ var ErrUnavailable = errors.New("GitHub App setup unavailable")

+ var ErrWebhookUnavailable = fmt.Errorf("%w: GitHub App webhook endpoint is unavailable", ErrUnavailable)

+ var Events = []string

+ var Permissions = map[string]string

+ type Created struct

+ HandoffURL string

+ ID string

+ type Handoff struct

+ Action string

+ Location string

+ Manifest string

+ OrgID string

+ type Hosted struct

+ AppID int64

+ ClientID string

+ ClientSecret []byte

+ PrivateKeyPEM []byte

+ Slug string

+ WebhookSecret []byte

+ func LoadHosted(f config.GitHubAppFiles) (*Hosted, error)

+ func (h Hosted) GoString() string

+ func (h Hosted) LogValue() slog.Value

+ func (h Hosted) String() string

+ type Options struct

+ API string

+ Development bool

+ Edition string

+ Hosted *Hosted

+ PublicURL string

+ Transport http.RoundTripper

+ Web string

+ type Pending struct

+ AppSlug string

+ ExpiresAt time.Time

+ ID string

+ Phase string

+ ResumeURL string

+ type Result struct

+ ConnectionID string

+ Location string

+ OrgID string

+ Outcome string

+ Reason string

+ type Service struct

+ func New(db *store.Store, identity *auth.Service, vault *secrets.Vault, ...) *Service

+ func (s *Service) Cancel(ctx context.Context, session auth.Session, org, id, request string) error

+ func (s *Service) Cleanup(ctx context.Context) error

+ func (s *Service) HandleWebhook(ctx context.Context, headers http.Header, body []byte) error

+ func (s *Service) Handoff(ctx context.Context, session auth.Session, id string) (Handoff, error)

+ func (s *Service) InstallCallback(ctx context.Context, session auth.Session, installation, action, state string) Result

+ func (s *Service) ManifestCallback(ctx context.Context, session auth.Session, code, state string) Result

+ func (s *Service) OAuthCallback(ctx context.Context, session auth.Session, code, state, providerError string) Result

+ func (s *Service) Run(ctx context.Context)

+ func (s *Service) Start(ctx context.Context, session auth.Session, ...) (Created, error)

+ func (s *Service) Status(ctx context.Context, session auth.Session, org string) (Status, error)

+ func (s *Service) WebOrigin() string

+ type Status struct

+ Mode string

+ Pending *Pending

+ Reason string