Apps
Download SpecInformation for integrations and installations.
Get the authenticated app
Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count
in the response. For more details about your app's installations, see the "List installations for the authenticated app" endpoint.
You must use a JWT to access this endpoint.
Response
Response
{
"id": 1,
"slug": "octoapp",
"node_id": "MDExOkludGVncmF0aW9uMQ==",
"owner": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": true
},
"name": "Octocat App",
"description": "",
"external_url": "https://example.com",
"html_url": "https://github.com/apps/octoapp",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"permissions": {
"metadata": "read",
"contents": "read",
"issues": "write",
"single_file": "write"
},
"events": [
"push",
"pull_request"
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
- Example
- "\"Iv1.25b5d1e65ffc4022\""
client_secret
string
- Example
- "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
webhook_secret
string or null
- Example
- "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
pem
string
- Example
- "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\""
Create a GitHub App from a manifest
Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code
used to retrieve the GitHub App's id
, pem
(private key), and webhook_secret
.
code
string
required
Response
Response
{
"id": 1,
"slug": "octoapp",
"node_id": "MDxOkludGVncmF0aW9uMQ==",
"owner": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": true
},
"name": "Octocat App",
"description": "",
"external_url": "https://example.com",
"html_url": "https://github.com/apps/octoapp",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"permissions": {
"metadata": "read",
"contents": "read",
"issues": "write",
"single_file": "write"
},
"events": [
"push",
"pull_request"
],
"client_id": "Iv1.8a61f9b3a7aba766",
"client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8",
"webhook_secret": "e340154128314309424b7c8e90325147d99fdafa",
"pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
required
client_secret
string
required
webhook_secret
string or null
required
pem
string
required
Get a webhook configuration for an app
Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."
You must use a JWT to access this endpoint.
Response
Response
{
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
url
string
uri
The URL to which the payloads will be delivered.
- Example
- "https://example.com/webhook"
content_type
string
The media type used to serialize the payloads. Supported values include json
and form
. The default is form
.
- Example
- "\"json\""
secret
string
If provided, the secret
will be used as the key
to generate the HMAC hex digest value for delivery signature headers.
- Example
- "\"********\""
insecure_ssl
One Of
string
Determines whether the SSL certificate of the host for url
will be verified when delivering payloads. Supported values include 0
(verification is performed) and 1
(verification is not performed). The default is 0
. We strongly recommend not setting this to 1
as you are subject to man-in-the-middle and other attacks.
- Example
- "\"0\""
number
Update a webhook configuration for an app
Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."
You must use a JWT to access this endpoint.
url
string
uri
The URL to which the payloads will be delivered.
- Example
- "https://example.com/webhook"
content_type
string
The media type used to serialize the payloads. Supported values include json
and form
. The default is form
.
- Example
- "\"json\""
secret
string
If provided, the secret
will be used as the key
to generate the HMAC hex digest value for delivery signature headers.
- Example
- "\"********\""
insecure_ssl
One Of
string
Determines whether the SSL certificate of the host for url
will be verified when delivering payloads. Supported values include 0
(verification is performed) and 1
(verification is not performed). The default is 0
. We strongly recommend not setting this to 1
as you are subject to man-in-the-middle and other attacks.
- Example
- "\"0\""
number
Request
{
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
Response
Response
{
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
url
string
uri
The URL to which the payloads will be delivered.
- Example
- "https://example.com/webhook"
content_type
string
The media type used to serialize the payloads. Supported values include json
and form
. The default is form
.
- Example
- "\"json\""
secret
string
If provided, the secret
will be used as the key
to generate the HMAC hex digest value for delivery signature headers.
- Example
- "\"********\""
insecure_ssl
One Of
string
Determines whether the SSL certificate of the host for url
will be verified when delivering payloads. Supported values include 0
(verification is performed) and 1
(verification is not performed). The default is 0
. We strongly recommend not setting this to 1
as you are subject to man-in-the-middle and other attacks.
- Example
- "\"0\""
number
List deliveries for an app webhook
Returns a list of webhook deliveries for the webhook configured for a GitHub App.
You must use a JWT to access this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
cursor
string
Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link
header for the next and previous page cursors.
redelivery
boolean
Response
Response
[
{
"id": 12345678,
"guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"delivered_at": "2019-06-03T00:57:16Z",
"redelivery": false,
"duration": 0.27,
"status": "OK",
"status_code": 200,
"event": "issues",
"action": "opened",
"installation_id": 123,
"repository_id": 456
},
{
"id": 123456789,
"guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"delivered_at": "2019-06-04T00:57:16Z",
"redelivery": true,
"duration": 0.28,
"status": "OK",
"status_code": 200,
"event": "issues",
"action": "opened",
"installation_id": 123,
"repository_id": 456
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string or null
documentation_url
string or null
detail
string or null
status
int
scimType
string or null
schemas
array[string]
string
Bad Request
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
array[object (Simple webhook delivery)]
- Content Type
- application/json
Simple webhook delivery
object (Simple webhook delivery)
Delivery made by a webhook, without request and response information.
id
int
required
Unique identifier of the webhook delivery.
- Example
- 42
guid
string
required
Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
- Example
- "58474f00-b361-11eb-836d-0e4f3503ccbe"
delivered_at
string
date-time
required
Time when the webhook delivery occurred.
- Example
- "2021-05-12T20:33:44Z"
redelivery
boolean
required
Whether the webhook delivery is a redelivery.
- Example
- false
duration
number
required
Time spent delivering.
- Example
- 0.03
status
string
required
Describes the response returned after attempting the delivery.
- Example
- "failed to connect"
status_code
int
required
Status code received when delivery was made.
- Example
- 502
event
string
required
The event that triggered the delivery.
- Example
- "issues"
action
string or null
required
The type of activity for the event that triggered the delivery.
- Example
- "opened"
installation_id
int or null
required
The id of the GitHub App installation associated with this event.
- Example
- 123
repository_id
int or null
required
The id of the repository associated with this event.
- Example
- 123
Get a delivery for an app webhook
Returns a delivery for the webhook configured for a GitHub App.
You must use a JWT to access this endpoint.
delivery_id
int
required
Response
Response
{
"id": 12345678,
"guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"delivered_at": "2019-06-03T00:57:16Z",
"redelivery": false,
"duration": 0.27,
"status": "OK",
"status_code": 200,
"event": "issues",
"action": "opened",
"installation_id": 123,
"repository_id": 456,
"url": "https://www.example.com",
"request": {
"headers": {
"X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
"Accept": "*/*",
"X-GitHub-Hook-ID": "42",
"User-Agent": "GitHub-Hookshot/b8c71d8",
"X-GitHub-Event": "issues",
"X-GitHub-Hook-Installation-Target-ID": "123",
"X-GitHub-Hook-Installation-Target-Type": "repository",
"content-type": "application/json",
"X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
},
"payload": {
"action": "opened",
"issue": {
"body": "foo"
},
"repository": {
"id": 123
}
}
},
"response": {
"headers": {
"Content-Type": "text/html;charset=utf-8"
},
"payload": "ok"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string or null
documentation_url
string or null
detail
string or null
status
int
scimType
string or null
schemas
array[string]
string
Bad Request
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
id
int
required
Unique identifier of the delivery.
- Example
- 42
guid
string
required
Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
- Example
- "58474f00-b361-11eb-836d-0e4f3503ccbe"
delivered_at
string
date-time
required
Time when the delivery was delivered.
- Example
- "2021-05-12T20:33:44Z"
redelivery
boolean
required
Whether the delivery is a redelivery.
- Example
- false
duration
number
required
Time spent delivering.
- Example
- 0.03
status
string
required
Description of the status of the attempted delivery
- Example
- "failed to connect"
status_code
int
required
Status code received when delivery was made.
- Example
- 502
event
string
required
The event that triggered the delivery.
- Example
- "issues"
action
string or null
required
The type of activity for the event that triggered the delivery.
- Example
- "opened"
installation_id
int or null
required
The id of the GitHub App installation associated with this event.
- Example
- 123
repository_id
int or null
required
The id of the repository associated with this event.
- Example
- 123
url
string
The URL target of the delivery.
- Example
- "https://www.example.com"
request
object (request)
required
headers
object (headers) or null
required
The request headers sent with the webhook delivery.
payload
object (payload) or null
required
The webhook payload.
response
object (response)
required
headers
object (headers) or null
required
The response headers received when the delivery was made.
payload
string or null
required
The response payload received.
Redeliver a delivery for an app webhook
Redeliver a delivery for the webhook configured for a GitHub App.
You must use a JWT to access this endpoint.
delivery_id
int
required
Response
Accepted
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
message
string or null
documentation_url
string or null
detail
string or null
status
int
scimType
string or null
schemas
array[string]
string
Bad Request
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
List installation requests for the authenticated app
Lists all the pending installation requests for the authenticated GitHub App.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
Response
List of integration installation requests
[
{
"id": 25381,
"node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==",
"account": {
"login": "octo-org",
"id": 6811672,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"repos_url": "https://api.github.com/users/octo-org/repos",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"type": "Organization",
"site_admin": false
},
"requester": {
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2022-07-08T16:18:44-04:00"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
Not modified
Empty response
Requires authentication
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
array[object (Integration Installation Request)]
- Content Type
- application/json
Integration Installation Request
object (Integration Installation Request)
Request to install an integration on a target
id
int
required
Unique identifier of the request installation.
- Example
- 42
node_id
string
- Example
- "MDExOkludGVncmF0aW9uMQ=="
account
Any Of
required
Simple User
object (Simple User)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
Enterprise
object (Enterprise)
An enterprise on GitHub.
description
string or null
A short description of the enterprise.
html_url
string
uri
required
- Example
- "https://github.com/enterprises/octo-business"
website_url
string or null
uri
The enterprise's website URL.
id
int
required
Unique identifier of the enterprise
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the enterprise.
- Example
- "Octo Business"
slug
string
required
The slug url identifier for the enterprise.
- Example
- "octo-business"
created_at
string or null
date-time
required
- Example
- "2019-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2019-01-26T19:14:43Z"
avatar_url
string
uri
required
requester
object (requester)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2022-07-08T16:18:44-04:00"
List installations for the authenticated app
You must use a JWT to access this endpoint.
The permissions the installation has are included under the permissions
key.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
since
string
date-time
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
outdated
string
Response
The permissions the installation has are included under the permissions
key.
[
{
"id": 1,
"account": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"access_tokens_url": "https://api.github.com/installations/1/access_tokens",
"repositories_url": "https://api.github.com/installation/repositories",
"html_url": "https://github.com/organizations/github/settings/installations/1",
"app_id": 1,
"target_id": 1,
"target_type": "Organization",
"permissions": {
"checks": "write",
"metadata": "read",
"contents": "read"
},
"events": [
"push",
"pull_request"
],
"single_file_name": "config.yaml",
"has_multiple_single_files": true,
"single_file_paths": [
"config.yml",
".github/issue_TEMPLATE.md"
],
"repository_selection": "selected",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Installation)]
- Content Type
- application/json
Installation
object (Installation)
Installation
id
int
required
The ID of the installation.
- Example
- 1
account
Any Of or null
required
Simple User
object (Simple User)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
Enterprise
object (Enterprise)
An enterprise on GitHub.
description
string or null
A short description of the enterprise.
html_url
string
uri
required
- Example
- "https://github.com/enterprises/octo-business"
website_url
string or null
uri
The enterprise's website URL.
id
int
required
Unique identifier of the enterprise
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the enterprise.
- Example
- "Octo Business"
slug
string
required
The slug url identifier for the enterprise.
- Example
- "octo-business"
created_at
string or null
date-time
required
- Example
- "2019-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2019-01-26T19:14:43Z"
avatar_url
string
uri
required
repository_selection
string
required
Describe whether all repositories have been selected or there's a selection involved
- Enum
-
- all
- selected
access_tokens_url
string
uri
required
- Example
- "https://api.github.com/installations/1/access_tokens"
repositories_url
string
uri
required
- Example
- "https://api.github.com/installation/repositories"
html_url
string
uri
required
- Example
- "https://github.com/organizations/github/settings/installations/1"
app_id
int
required
- Example
- 1
target_id
int
required
The ID of the user or organization this token is being scoped to.
target_type
string
required
- Example
- "Organization"
permissions
object (permissions)
required
The permissions granted to the user-to-server access token.
- Example
- { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" }
actions
string
The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.
- Enum
-
- read
- write
administration
string
The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.
- Enum
-
- read
- write
checks
string
The level of permission to grant the access token for checks on code.
- Enum
-
- read
- write
contents
string
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
- Enum
-
- read
- write
deployments
string
The level of permission to grant the access token for deployments and deployment statuses.
- Enum
-
- read
- write
environments
string
The level of permission to grant the access token for managing repository environments.
- Enum
-
- read
- write
issues
string
The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.
- Enum
-
- read
- write
metadata
string
The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.
- Enum
-
- read
- write
packages
string
The level of permission to grant the access token for packages published to GitHub Packages.
- Enum
-
- read
- write
pages
string
The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.
- Enum
-
- read
- write
pull_requests
string
The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.
- Enum
-
- read
- write
repository_hooks
string
The level of permission to grant the access token to manage the post-receive hooks for a repository.
- Enum
-
- read
- write
repository_projects
string
The level of permission to grant the access token to manage repository projects, columns, and cards.
- Enum
-
- read
- write
- admin
secret_scanning_alerts
string
The level of permission to grant the access token to view and manage secret scanning alerts.
- Enum
-
- read
- write
secrets
string
The level of permission to grant the access token to manage repository secrets.
- Enum
-
- read
- write
security_events
string
The level of permission to grant the access token to view and manage security events like code scanning alerts.
- Enum
-
- read
- write
single_file
string
The level of permission to grant the access token to manage just a single file.
- Enum
-
- read
- write
statuses
string
The level of permission to grant the access token for commit statuses.
- Enum
-
- read
- write
vulnerability_alerts
string
The level of permission to grant the access token to manage Dependabot alerts.
- Enum
-
- read
- write
workflows
string
The level of permission to grant the access token to update GitHub Actions workflow files.
- Enum
-
- write
members
string
The level of permission to grant the access token for organization teams and members.
- Enum
-
- read
- write
organization_administration
string
The level of permission to grant the access token to manage access to an organization.
- Enum
-
- read
- write
organization_custom_roles
string
The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.
- Enum
-
- read
- write
organization_announcement_banners
string
The level of permission to grant the access token to view and manage announcement banners for an organization.
- Enum
-
- read
- write
organization_hooks
string
The level of permission to grant the access token to manage the post-receive hooks for an organization.
- Enum
-
- read
- write
organization_personal_access_tokens
string
The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.
- Enum
-
- read
- write
organization_personal_access_token_requests
string
The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.
- Enum
-
- read
- write
organization_plan
string
The level of permission to grant the access token for viewing an organization's plan.
- Enum
-
- read
organization_projects
string
The level of permission to grant the access token to manage organization projects and projects beta (where available).
- Enum
-
- read
- write
- admin
organization_packages
string
The level of permission to grant the access token for organization packages published to GitHub Packages.
- Enum
-
- read
- write
organization_secrets
string
The level of permission to grant the access token to manage organization secrets.
- Enum
-
- read
- write
organization_self_hosted_runners
string
The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.
- Enum
-
- read
- write
organization_user_blocking
string
The level of permission to grant the access token to view and manage users blocked by the organization.
- Enum
-
- read
- write
team_discussions
string
The level of permission to grant the access token to manage team discussions and related comments.
- Enum
-
- read
- write
events
array[string]
required
string
created_at
string
date-time
required
updated_at
string
date-time
required
single_file_name
string or null
required
- Example
- "config.yaml"
has_multiple_single_files
boolean
- Example
- true
single_file_paths
array[string]
- Example
- [ "config.yml", ".github/issue_TEMPLATE.md" ]
string
app_slug
string
required
- Example
- "github-actions"
suspended_by
object (suspended_by) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/oct