Update a repository webhook

PATCH

/repos/{owner}/{repo}/hooks/{hook_id}

Updates a webhook configured in a repository. 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 a repository.”

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

hook_id

required

integer

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

Request Body ^required

Media type application/json

object

config

Webhook Configuration

Configuration object of the webhook

object

url

The URL to which the payloads will be delivered.

string format: uri

content_type

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

string

secret

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

string

insecure_ssl

One of:

string

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.

string

number

number

events

Determines what events the hook is triggered for. This replaces the entire array of events.

Array<string>

default: push

add_events

Determines a list of events to be added to the list of events that the Hook triggers for.

Array<string>

remove_events

Determines a list of events to be removed from the list of events that the Hook triggers for.

Array<string>

active

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

boolean

default: true

Examples

Example default

{
  "active": true,
  "add_events": [
    "pull_request"
  ]
}

Responses

200

Response

Media type application/json

Webhook

Webhooks for repositories.

object

type

required

string

id

required

Unique identifier of the webhook.

integer

name

required

The name of a valid service, use ‘web’ for a webhook.

string

active

required

Determines whether the hook is actually triggered on pushes.

boolean

events

required

Determines what events the hook is triggered for. Default: [‘push’].

Array<string>

config

required

Webhook Configuration

Configuration object of the webhook

object

url

The URL to which the payloads will be delivered.

string format: uri

content_type

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

string

secret

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

string

insecure_ssl

One of:

string

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.

string

number

number

updated_at

required

string format: date-time

created_at

required

string format: date-time

url

required

string format: uri

test_url

required

string format: uri

ping_url

required

string format: uri

deliveries_url

string format: uri

last_response

required

Hook Response

object

code

required

integer

nullable

status

required

string

nullable

message

required

string

nullable

Examples

Example default

{
  "type": "Repository",
  "id": 12345678,
  "name": "web",
  "active": true,
  "events": [
    "push",
    "pull_request"
  ],
  "config": {
    "content_type": "json",
    "insecure_ssl": "0",
    "url": "https://example.com/webhook"
  },
  "updated_at": "2019-06-03T00:57:16Z",
  "created_at": "2019-06-03T00:57:16Z",
  "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
  "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
  "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
  "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
  "last_response": {
    "code": null,
    "status": "unused",
    "message": null
  }
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Validation failed, or the endpoint has been spammed.

Media type application/json

Validation Error

Validation Error

object

message

required

string

documentation_url

required

string

errors

Array<object>

object

resource

string

field

string

message

string

code

required

string

index

integer

value

One of:

string

string

nullable

integer

integer

nullable

Array<string>

Array<string>

nullable

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}