GitHub API (unofficial showcase)
PATCH/app/hook/config

Update a webhook configuration for an app

Updates the webhook configuration for a GitHub App, including its payload URL and delivery settings. Supply url as a URI; content_type defaults to form, and insecure_ssl defaults to 0. Authenticate with a GitHub App JWT to access this endpoint.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Webhook configuration settings for a GitHub App.

urlstringoptional
The URL to which the payloads will be delivered.
content_typestringoptional
The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
secretstringoptional
If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
insecure_sslstringoptional
Controls SSL certificate verification for the webhook URL: `0` verifies the certificate and `1` disables verification. Defaults to `0` when omitted.

1 status code
200Returns the updated webhook configuration, including its URL and delivery settings.
urlstringoptional
The URL to which the payloads will be delivered.
content_typestringoptional
The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
secretstringoptional
If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
insecure_sslstringoptional
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.**

Error handling

The url value must be a valid URI, and content_type must be json or form if supplied. insecure_ssl accepts 0 to verify the host's SSL certificate or 1 to skip verification; it defaults to 0.