How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Webhooks API

The Webhooks API from GitHub — 19 operation(s) for webhooks.

GitHub Webhooks API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 28 operations across 19 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

28 operations 19 paths 17 schemas 2 DELETE13 GET5 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 28

Across 19 paths, the API surfaces 28 operations — 2 DELETE, 13 GET, 5 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 28
GET
/app/hook/config
GitHub Getwebhook Configuration for an App
getwebhookConfigurationForAnApp → 200
PATCH
/app/hook/config
GitHub Updatewebhook Configuration for an App
updatewebhookConfigurationForAnApp body → 200
GET
/app/hook/deliveries
GitHub List Deliveries for an App Webhook
listDeliveriesForAnAppWebhook 3 params → 200400422
GET
/app/hook/deliveries/{delivery_id}
GitHub Getdelivery for an App Webhook
getdeliveryForAnAppWebhook 1 param → 200400422
POST
/app/hook/deliveries/{delivery_id}/attempts
GitHub Redeliverdelivery for an App Webhook
redeliverdeliveryForAnAppWebhook 1 param → 202400422
GET
/orgs/{org}/hooks
GitHub List Organization Webhooks
listOrganizationWebhooks 3 params → 200404
POST
/orgs/{org}/hooks
GitHub Create an Organization Webhook
createAnOrganizationWebhook 1 param body → 201404422
GET
/orgs/{org}/hooks/{hook_id}
GitHub Get an Organization Webhook
getAnOrganizationWebhook 2 params → 200404
PATCH
/orgs/{org}/hooks/{hook_id}
GitHub Update an Organization Webhook
updateAnOrganizationWebhook 2 params body → 200404422
DELETE
/orgs/{org}/hooks/{hook_id}
GitHub Delete an Organization Webhook
deleteAnOrganizationWebhook 2 params → 204404
GET
/orgs/{org}/hooks/{hook_id}/config
GitHub Get Webhook Configuration for an Organization
getWebhookConfigurationForAnOrganization 2 params → 200
PATCH
/orgs/{org}/hooks/{hook_id}/config
GitHub Update Webhook Configuration for an Organization
updateWebhookConfigurationForAnOrganization 2 params body → 200
GET
/orgs/{org}/hooks/{hook_id}/deliveries
GitHub List Deliveries for an Organization Webhook
listDeliveriesForAnOrganizationWebhook 5 params → 200400422
GET
/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}
GitHub Get Webhook Delivery for an Organization Webhook
getWebhookDeliveryForAnOrganizationWebhook 3 params → 200400422
POST
/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts
GitHub Redeliver Delivery for an Organization Webhook
redeliverDeliveryForAnOrganizationWebhook 3 params → 202400422
POST
/orgs/{org}/hooks/{hook_id}/pings
GitHub Ping an Organization Webhook
pingAnOrganizationWebhook 2 params → 204404
GET
/repos/{owner}/{repo}/hooks
GitHub List Repository Webhooks
listRepositoryWebhooks 7 params → 200404
POST
/repos/{owner}/{repo}/hooks
GitHub Create Repository Webhook
createRepositoryWebhook 5 params body → 201403404422
GET
/repos/{owner}/{repo}/hooks/{hook_id}
GitHub Get Repository Webhook
getRepositoryWebhook 6 params → 200404
PATCH
/repos/{owner}/{repo}/hooks/{hook_id}
GitHub Update Repository Webhook
updateRepositoryWebhook 6 params body → 200404422
DELETE
/repos/{owner}/{repo}/hooks/{hook_id}
GitHub Delete Repository Webhook
deleteRepositoryWebhook 6 params → 204404
GET
/repos/{owner}/{repo}/hooks/{hook_id}/config
GitHub Get Webhook Configuration for Repository
getWebhookConfigurationForRepository 6 params → 200
PATCH
/repos/{owner}/{repo}/hooks/{hook_id}/config
GitHub Update Webhook Configuration for Repository
updateWebhookConfigurationForRepository 6 params body → 200
GET
/repos/{owner}/{repo}/hooks/{hook_id}/deliveries
GitHub List Deliveries for Repository Webhook
listDeliveriesForRepositoryWebhook 9 params → 200400422
GET
/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}
GitHub Get Delivery for Repository Webhook
getDeliveryForRepositoryWebhook 7 params → 200400422
POST
/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts
GitHub Redeliver Delivery for Repository Webhook
redeliverDeliveryForRepositoryWebhook 7 params → 202400422
POST
/repos/{owner}/{repo}/hooks/{hook_id}/pings
GitHub Ping Repository Webhook
pingRepositoryWebhook 6 params → 204404
POST
/repos/{owner}/{repo}/hooks/{hook_id}/tests
GitHub Test the Push Repository Webhook
testThePushRepositoryWebhook 6 params → 204404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are hook-delivery_2 (15 properties), hook-delivery (14 properties), hook (13 properties), hook-delivery-item_2 (12 properties). Each schema is shown below with its type and property counts.

scim-error
object
Scim Error
6 properties
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
validation-error
object
Validation Error
3 properties 2 required
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](https://docs.github.com/enterprise-serve…
basic-error
object
Basic Error
4 properties
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-config-insecure-ssl
hook-delivery-item
object
Delivery made by a webhook, without request and response information.
11 properties 11 required
hook-delivery
object
Delivery made by a webhook.
14 properties 13 required
webhook-config
object
Configuration object of the webhook
4 properties
org-hook
object
Org Hook
11 properties 10 required
scim-error_2
object
Scim Error
6 properties
hook-response
object
3 properties 3 required
validation-error_2
object
Validation Error
3 properties 2 required
hook
object
Webhooks for repositories.
13 properties 12 required
hook-delivery-item_2
object
Delivery made by a webhook, without request and response information.
12 properties 11 required
hook-delivery_2
object
Delivery made by a webhook.
15 properties 13 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-webhooks-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.