Search
K
GitHub v3 REST API

webhook-config-secret

string

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

Example

webhook-config-insecure-ssl

One Of
Example

Webhook Configuration

object

Configuration object of the webhook

urlstring(uri)

The URL to which the payloads will be delivered.

Example:https://example.com/webhook

content_typestring

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

Example:"json"

secretstring

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

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

insecure_sslOne Of
Variant 1string

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"

Example

Enterprise

object

An enterprise account

descriptionstring

A short description of the enterprise.

html_urlstring(uri)required

Example:https://github.com/enterprises/octo-business

website_urlstring(uri)

The enterprise’s website URL.

idintegerrequired

Unique identifier of the enterprise

Example:42

node_idstringrequired

Example:MDEwOlJlcG9zaXRvcnkxMjk2MjY5

namestringrequired

The name of the enterprise.

Example:Octo Business

slugstringrequired

The slug url identifier for the enterprise.

Example:octo-business

created_atstring(date-time)required

Example:2019-01-26T19:01:12Z

updated_atstring(date-time)required

Example:2019-01-26T19:14:43Z

avatar_urlstring(uri)required
Example

Installation

object

Installation

idintegerrequired

The ID of the installation.

Example:1

accountAny Of
required
Simple Userobject

Simple User

Show Child Parameters
repository_selectionstringrequired

Describe whether all repositories have been selected or there’s a selection involved

Allowed values:allselected

access_tokens_urlstring(uri)required

Example:https://api.github.com/installations/1/access_tokens

repositories_urlstring(uri)required

Example:https://api.github.com/installation/repositories

html_urlstring(uri)required

Example:https://github.com/organizations/github/settings/installations/1

app_idintegerrequired

Example:1

target_idintegerrequired

The ID of the user or organization this token is being scoped to.

target_typestringrequired

Example:Organization

permissionsobjectrequired

The permissions granted to the user-to-server access token.

Example:{"contents":"read","issues":"read","deployments":"write","single_file":"read"}

Show Child Parameters
eventsarray[string]required
created_atstring(date-time)required
updated_atstring(date-time)required
single_file_namestringrequired

Example:config.yaml

has_multiple_single_filesboolean

Example:true

single_file_pathsarray[string]

Example:config.yml, .github/issue_TEMPLATE.md

app_slugstringrequired

Example:github-actions

suspended_byobjectrequired

Simple User

Show Child Parameters
suspended_atstring(date-time)required
contact_emailstring

Example:"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"

Example