Skip to main content
Manja / GitHub

Get a webhook configuration for an app

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." You must use a [JWT](https://docs.github.com/[email protected]/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

GET/app/hook/config
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Responses

application/json Webhook Configuration object

Response

content_type webhook-config-content-type string
optional

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

Example: "json"

insecure_ssl webhook-config-insecure-ssl
optional
secret webhook-config-secret string
optional

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/[email protected]/webhooks/event-payloads/#delivery-headers).

Example: "********"

url webhook-config-url string<uri>
optional

The URL to which the payloads will be delivered.

Example: https://example.com/webhook