name | example | route | scope | type |
---|---|---|---|---|
Update an organization webhook |
octokit.rest.orgs.updateWebhook({ org, hook_id, config.url }) |
PATCH /orgs/{org}/hooks/{hook_id} |
orgs |
API method |
Updates a webhook configured in an organization. When you update a webhook,
the secret
will be overwritten. If you previously had a secret
set, you must
provide the same secret
or set a new secret
or the secret will be removed. If
you are only updating individual webhook config
properties, use "Update a webhook
configuration for an organization".
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.
octokit.rest.orgs.updateWebhook({
org,
hook_id,
config.url
})
name | required | description |
---|---|---|
org | yes |
The organization name. The name is not case sensitive. |
hook_id | yes |
The unique identifier of the hook. You can find this value in the |
config | no |
Key/value pairs to provide settings for this webhook. |
config.url | yes |
The URL to which the payloads will be delivered. |
config.content_type | no |
The media type used to serialize the payloads. Supported values include |
config.secret | no |
If provided, the |
config.insecure_ssl | no | |
events | no |
Determines what events the hook is triggered for. |
active | no |
Determines if notifications are sent when the webhook is triggered. Set to |
name | no |
See also: GitHub Developer Guide documentation.