integrations

Creates, updates, deletes, gets or lists an integrations resource.

Overview

Name	integrations
Type	Resource
Id	github.apps.integrations

Fields

The following fields are returned by SELECT queries:

get_by_slug

Response

Name	Datatype	Description
id	integer	Unique identifier of the GitHub app
name	string	The name of the GitHub app (example: Probot Owners)
client_id	string	(example: "Iv1.25b5d1e65ffc4022")
node_id	string	(example: MDExOkludGVncmF0aW9uMQ==)
created_at	string (date-time)	(example: 2017-07-08T16:18:44-04:00)
description	string	(example: The description of the app.)
events	array	The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
external_url	string (uri)	(example: https://example.com)
html_url	string (uri)	(example: https://github.com/apps/super-ci)
installations_count	integer	The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
owner	object	A GitHub user. (title: Simple User)
permissions	object	The set of permissions for the GitHub app
slug	string	The slug name of the GitHub app (example: probot-owners)
updated_at	string (date-time)	(example: 2017-07-08T16:18:44-04:00)

get_authenticated

Response

Name	Datatype	Description
id	integer	Unique identifier of the GitHub app
name	string	The name of the GitHub app (example: Probot Owners)
client_id	string	(example: "Iv1.25b5d1e65ffc4022")
node_id	string	(example: MDExOkludGVncmF0aW9uMQ==)
created_at	string (date-time)	(example: 2017-07-08T16:18:44-04:00)
description	string	(example: The description of the app.)
events	array	The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
external_url	string (uri)	(example: https://example.com)
html_url	string (uri)	(example: https://github.com/apps/super-ci)
installations_count	integer	The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
owner	object	A GitHub user. (title: Simple User)
permissions	object	The set of permissions for the GitHub app
slug	string	The slug name of the GitHub app (example: probot-owners)
updated_at	string (date-time)	(example: 2017-07-08T16:18:44-04:00)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_slug	select	app_slug		> [!NOTE] > 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).
get_authenticated	select			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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
app_slug	string

SELECT examples

get_by_slug

> [!NOTE]
> 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).

SELECT
id,
name,
client_id,
node_id,
created_at,
description,
events,
external_url,
html_url,
installations_count,
owner,
permissions,
slug,
updated_at
FROM github.apps.integrations
WHERE app_slug = '{{ app_slug }}' -- required
;

get_authenticated

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.

SELECT
id,
name,
client_id,
node_id,
created_at,
description,
events,
external_url,
html_url,
installations_count,
owner,
permissions,
slug,
updated_at
FROM github.apps.integrations
;