Sample - GitHub REST API
POST/orgs/{org}/hooks/{hook_id}/pings

Ping an organization webhook

This will trigger a ping event to be sent to the hook.

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.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
orgstringrequired
The organization name. The name is not case sensitive.
hook_idintegerrequired
The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.

2 status codes
204Response
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.