PATCH/orgs/{org}/hooks/{hook_id}/config

Update a webhook configuration for an organization

Updates the configuration used to deliver an organization webhook's payloads. Set url, content_type, secret, or insecure_ssl without changing the webhook's active state or subscribed events. You must be an organization owner, and OAuth app tokens and personal access tokens (classic) need the admin:org_hook scope.

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

2 parameters · 4 body fields
orgstringrequired
The organization name; matching is not case-sensitive. You must be an organization owner, and OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope.
hook_idintegerrequired
The unique identifier of the webhook, available in the `X-GitHub-Hook-ID` header of a webhook delivery.

Optional webhook delivery configuration 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
Controls SSL certificate verification for the delivery URL; `0` verifies the certificate and `1` disables verification. Defaults to `0` when omitted.

1 status code
200Returns the webhook configuration, including the delivery URL, payload media type, secret, and SSL verification setting.
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 org path parameter identifies the organization, and the hook_id path parameter identifies the webhook. url must be a URI when provided; content_type accepts json or form, and insecure_ssl accepts 0 or 1. You must be an organization owner, and OAuth app tokens and personal access tokens (classic) need the admin:org_hook scope.