Skip to main content
Manja / GitHub
Schema1.1.4object

hook

Webhooks for repositories.

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Webhook

object

Webhooks for repositories.

active boolean
required

Determines whether the hook is actually triggered on pushes.

Example:true

config object
required
created_at string (date-time)
required

Example:2011-09-06T17:26:27Z

events array
required

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

Example:[ "push", "pull_request" ]

id integer
required

Unique identifier of the webhook.

Example:42

name string
required

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

Example:web

ping_url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1/pings

test_url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1/test

type string
required
updated_at string (date-time)
required

Example:2011-09-06T20:39:23Z

url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1