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
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

v1

v1.16.12

Apr 14, 2026

v1.16.11

Apr 13, 2026

v1.16.10

Apr 13, 2026

v1.16.9

Apr 12, 2026

v1.16.8

Apr 11, 2026

v1.16.7

Apr 11, 2026

v1.16.6

Apr 9, 2026

v1.16.5

Apr 9, 2026

v1.16.4

Apr 8, 2026

v1.16.3

Apr 8, 2026

v1.16.2

Apr 8, 2026

Changes in this version

type Client

+ AppConfig Config

v1.16.1

Apr 7, 2026

v1.16.0

Apr 7, 2026

Changes in this version

type UserInput

+ PrimaryDirectory bool

v1.15.9

Apr 6, 2026

v1.15.8

Apr 5, 2026

v1.15.7

Apr 3, 2026

v1.15.6

Apr 3, 2026

v1.15.5

Apr 3, 2026

v1.15.4

Apr 3, 2026

v1.15.3

Apr 3, 2026

v1.15.2

Apr 2, 2026

v1.15.1

Apr 1, 2026

v1.15.0

Apr 1, 2026

Changes in this version

+ var DefinitionID = types.NewDefinitionRef("def_01K0GHAPP000000000000000001")

+ var ErrAPIRequest = errors.New("githubapp: api request failed")

+ var ErrAccessTokenMissing = errors.New("githubapp: access token missing")

+ var ErrAppIDMissing = errors.New("githubapp: app id missing")

+ var ErrAppSlugMissing = errors.New("githubapp: app slug missing")

+ var ErrAuthCompleteInputInvalid = errors.New("githubapp: auth complete input invalid")

+ var ErrAuthStartInputInvalid = errors.New("githubapp: auth start input invalid")

+ var ErrAuthStateDecode = errors.New("githubapp: auth state decode failed")

+ var ErrAuthStateEncode = errors.New("githubapp: auth state encode failed")

+ var ErrAuthStateGenerate = errors.New("githubapp: auth state generate failed")

+ var ErrAuthStateMismatch = errors.New("githubapp: auth state mismatch")

+ var ErrClientType = errors.New("githubapp: unexpected client type")

+ var ErrCredentialDecode = errors.New("githubapp: credential decode failed")

+ var ErrCredentialEncode = errors.New("githubapp: credential encode failed")

+ var ErrIngestPayloadEncode = errors.New("githubapp: ingest payload encode failed")

+ var ErrInstallationIDMissing = errors.New("githubapp: installation id missing")

+ var ErrInstallationMetadataDecode = errors.New("githubapp: installation metadata decode failed")

+ var ErrInstallationMetadataEncode = errors.New("githubapp: installation metadata encode failed")

+ var ErrInstallationTokenEmpty = errors.New("githubapp: installation token empty")

+ var ErrInstallationTokenRequestFailed = errors.New("githubapp: installation token request failed")

+ var ErrJWTSigningFailed = errors.New("githubapp: jwt signing failed")

+ var ErrOperationConfigInvalid = errors.New("githubapp: operation config invalid")

+ var ErrPrivateKeyInvalid = errors.New("githubapp: private key invalid")

+ var ErrPrivateKeyMissing = errors.New("githubapp: private key missing")

+ var ErrResultEncode = errors.New("githubapp: result encode failed")

+ var ErrWebhookEventMissing = errors.New("githubapp: webhook event missing")

+ var ErrWebhookIngestFailed = errors.New("githubapp: webhook ingest failed")

+ var ErrWebhookMetadataEncode = errors.New("githubapp: webhook metadata encode failed")

+ var ErrWebhookPayloadInvalid = errors.New("githubapp: webhook payload invalid")

+ var ErrWebhookPersistFailed = errors.New("githubapp: webhook persist failed")

+ var ErrWebhookSecretMissing = errors.New("githubapp: webhook secret missing")

+ var ErrWebhookSignatureMismatch = errors.New("githubapp: webhook signature mismatch")

+ var ErrWebhookSignatureMissing = errors.New("githubapp: webhook signature missing")

+ var InstallationEventsWebhook = types.NewWebhookRef("installation.events")

+ func Builder(cfg Config) registry.Builder

+ type App struct

+ Config Config

+ func (App) Event(request types.WebhookInboundRequest) (types.WebhookReceivedEvent, error)

+ func (a App) Verify(request types.WebhookInboundRequest) error

+ type Client struct

+ APIURL string

+ func (c Client) Build(ctx context.Context, req types.ClientBuildRequest) (any, error)

+ type CodeScanningAlertWebhook struct

+ func (CodeScanningAlertWebhook) Handle(ctx context.Context, request types.WebhookHandleRequest) error

+ type Config struct

+ APIURL string

+ AppID string

+ AppSlug string

+ PrivateKey string

+ WebhookSecret string

+ type DependabotAlertWebhook struct

+ func (DependabotAlertWebhook) Handle(ctx context.Context, request types.WebhookHandleRequest) error

+ type DirectorySync struct

+ func (DirectorySync) Run(ctx context.Context, client GraphQLClient) ([]types.IngestPayloadSet, error)

+ func (d DirectorySync) IngestHandle() types.IngestHandler

+ type GraphQLClient interface

+ Query func(ctx context.Context, q any, variables map[string]any) error

+ type HealthCheck struct

+ func (HealthCheck) Run(ctx context.Context, client GraphQLClient) (json.RawMessage, error)

+ func (h HealthCheck) Handle() types.OperationHandler

+ type InstallationCreatedWebhook struct

+ func (InstallationCreatedWebhook) Handle(ctx context.Context, request types.WebhookHandleRequest) error

+ type InstallationDeletedWebhook struct

+ func (InstallationDeletedWebhook) Handle(ctx context.Context, request types.WebhookHandleRequest) error

+ type InstallationMetadata struct

+ InstallationID string

+ func (m InstallationMetadata) InstallationIdentity() types.IntegrationInstallationIdentity

+ type PingWebhook struct

+ func (PingWebhook) Handle(ctx context.Context, request types.WebhookHandleRequest) error

+ type RepositoryAssetPayload struct

+ IsPrivate bool

+ NameWithOwner string

+ URL string

+ UpdatedAt time.Time

+ type RepositorySync struct

+ func (RepositorySync) Run(ctx context.Context, client GraphQLClient) ([]types.IngestPayloadSet, error)

+ func (r RepositorySync) IngestHandle() types.IngestHandler

+ type SecretScanningAlertWebhook struct

+ func (SecretScanningAlertWebhook) Handle(ctx context.Context, request types.WebhookHandleRequest) error

+ type SecurityAdvisory struct

+ CVEID string

+ Description string

+ GHSAID string

+ Severity string

+ Summary string

+ type UserInput struct

+ FilterExpr string

+ type VulnerabilityAlertPayload struct

+ CreatedAt time.Time

+ HTMLURL string

+ Number int

+ SecurityAdvisory SecurityAdvisory

+ State string

+ UpdatedAt time.Time

+ type VulnerabilityCollect struct

+ func (VulnerabilityCollect) Run(ctx context.Context, client GraphQLClient, config VulnerabilityCollectConfig) ([]types.IngestPayloadSet, error)

+ func (v VulnerabilityCollect) IngestHandle() types.IngestHandler

+ type VulnerabilityCollectConfig struct

+ MaxRepos int