orgs

Get a webhook configuration for an organization

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use "Get 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.

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

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/hooks/{hook_id}/config
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

hook_idinteger required

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

Response

Response

urlstring uri

The URL to which the payloads will be delivered.

content_typestring

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

secretstring

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

Example response

{
  "url": "https://example.com/webhook",
  "content_type": "\"json\"",
  "secret": "\"********\"",
  "insecure_ssl": "\"0\""
}

Changes

No recorded changes to this operation across all 23 revisions of this API.