v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-03-2585861610.1 MB

orgs

List deliveries for an organization webhook

Returns a list of webhook deliveries for a webhook configured in an organization.

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.

get/orgs/{org}/hooks/{hook_id}/deliveries

Path parameters

orgstring required

The organization name. The name is not case sensitive.

hook_idinteger required

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

Query parameters

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

cursorstring

Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors.

redeliveryboolean

Response

idinteger required

Unique identifier of the webhook delivery.

guidstring required

Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).

delivered_atstring date-time required

Time when the webhook delivery occurred.

redeliveryboolean required

Whether the webhook delivery is a redelivery.

durationnumber required

Time spent delivering.

statusstring required

Describes the response returned after attempting the delivery.

status_codeinteger required

Status code received when delivery was made.

eventstring required

The event that triggered the delivery.

actionstring nullable required

The type of activity for the event that triggered the delivery.

installation_idinteger nullable required

The id of the GitHub App installation associated with this event.

repository_idinteger nullable required

The id of the repository associated with this event.

Example response

[
  {
    "id": 42,
    "guid": "58474f00-b361-11eb-836d-0e4f3503ccbe",
    "delivered_at": "2021-05-12T20:33:44Z",
    "duration": 0.03,
    "status": "failed to connect",
    "status_code": 502,
    "event": "issues",
    "action": "opened",
    "installation_id": 123,
    "repository_id": 123
  }
]