Back to GithubUpdate a webhook configuration for a repository
Updates the webhook configuration for a repository. To update more information about the webhook, including the active
state and events
, use "Update a repository webhook."
Access tokens must have the write:repo_hook
or repo
scope, and GitHub Apps must have the repository_hooks:write
permission.
Input
type: object
properties:
parameters:
type: object
properties:
owner:
type: string
description: The account owner of the repository. The name is not case sensitive.
repo:
type: string
description: The name of the repository. The name is not case sensitive.
hook_id:
type: integer
description: The unique identifier of the hook.
required:
- owner
- repo
- hook_id
title: Parameters
data:
type: object
properties:
url:
type: string
description: The URL to which the payloads will be delivered.
example: https://example.com/webhook
format: uri
content_type:
type: string
description: >-
The media type used to serialize the payloads. Supported values
include `json` and `form`. The default is `form`.
example: '"json"'
secret:
type: string
description: >-
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).
example: '"********"'
insecure_ssl:
oneOf:
- type: string
description: >-
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.**
example: '"0"'
- type: number
title: Data
Output
type: object
title: Webhook Configuration
properties:
url:
type: string
description: The URL to which the payloads will be delivered.
example: https://example.com/webhook
format: uri
content_type:
type: string
description: >-
The media type used to serialize the payloads. Supported values include
`json` and `form`. The default is `form`.
example: '"json"'
secret:
type: string
description: >-
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).
example: '"********"'
insecure_ssl:
oneOf:
- type: string
description: >-
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.**
example: '"0"'
- type: number