webhook_config

Creates, updates, deletes, gets or lists a webhook_config resource.

Overview

Name	webhook_config
Type	Resource
Id	github.apps.webhook_config

Fields

The following fields are returned by SELECT queries:

get_webhook_config_for_app

Response

Name	Datatype	Description
content_type	string	The media type used to serialize the payloads. Supported values include json and form. The default is form. (example: "json")
insecure_ssl	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")
secret	string	If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers. (example: "********")
url	string (uri)	The URL to which the payloads will be delivered. (example: https://example.com/webhook)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_webhook_config_for_app	select			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.
update_webhook_config_for_app	update			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.

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

SELECT examples

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

SELECT
content_type,
insecure_ssl,
secret,
url
FROM github.apps.webhook_config
;

UPDATE examples

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

UPDATE github.apps.webhook_config
SET 
url = '{{ url }}',
content_type = '{{ content_type }}',
secret = '{{ secret }}',
insecure_ssl = '{{ insecure_ssl }}'
RETURNING
content_type,
insecure_ssl,
secret,
url;