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

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use "Update an organization webhook."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

Servers

Path parameters

Name Type Required Description
org String Yes

The organization name. The name is not case sensitive.

hook_id Integer Yes

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
content_type String No

The media type used to serialize the payloads. Supported values include json and form. The default is form.

url String No

The URL to which the payloads will be delivered.

secret String No

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

insecure_ssl No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.