Skip to main content
Manja / GitHub
Schema1.1.4object

nullable-integration

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

GitHub app

object

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Status: nullable

client_id string
optional

Example:"Iv1.25b5d1e65ffc4022"

client_secret string
optional

Example:"1d4b2097ac622ba702d19de498f005747a8b21d3"

created_at string (date-time)
required

Example:2017-07-08T16:18:44-04:00

description string
requirednullable

Example:The description of the app.

events array
required

The list of events for the GitHub app

Example:[ "label", "deployment" ]

external_url string (uri)
required

Example:https://example.com

html_url string (uri)
required

Example:https://github.com/apps/super-ci

id integer
required

Unique identifier of the GitHub app

Example:37

installations_count integer
optional

The number of installations associated with the GitHub app

Example:5

name string
required

The name of the GitHub app

Example:Probot Owners

node_id string
required

Example:MDExOkludGVncmF0aW9uMQ==

pem string
optional

Example:"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2Erk…

permissions object
required

The set of permissions for the GitHub app

Example:{ "deployments": "write", "issues": "read" }

slug string
optional

The slug name of the GitHub app

Example:probot-owners

updated_at string (date-time)
required

Example:2017-07-08T16:18:44-04:00

webhook_secret string
optionalnullable

Example:"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"