Skip to main content

integrations

Overview

Nameintegrations
TypeResource
Idgithub.apps.integrations

Fields

NameDatatypeDescription
idintegerUnique identifier of the GitHub app
namestringThe name of the GitHub app
descriptionstring
eventsarrayThe list of events for the GitHub app
installations_countintegerThe number of installations associated with the GitHub app
slugstringThe slug name of the GitHub app
client_secretstring
node_idstring
external_urlstring
html_urlstring
client_idstring
updated_atstring
created_atstring
pemstring
ownerobjectSimple User
webhook_secretstring
permissionsobjectThe set of permissions for the GitHub app

Methods

NameAccessible byRequired ParamsDescription
get_authenticatedSELECTReturns 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.
get_by_slugSELECTapp_slugNote: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
create_from_manifestINSERTcodeUse 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.