Get a delivery for a repository webhook

GET

/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}

Returns a delivery for a webhook configured in a repository.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///hooks//deliveries/'

Response Example

200 - Example 1

{
    "action": "opened",
    "delivered_at": "2021-05-12T20:33:44.000Z",
    "duration": 0.03,
    "event": "issues",
    "guid": "58474f00-b361-11eb-836d-0e4f3503ccbe",
    "id": 42,
    "installation_id": 123,
    "redelivery": false,
    "repository_id": 123,
    "request": {
        "headers": {},
        "payload": {}
    },
    "response": {
        "headers": {},
        "payload": "string"
    },
    "status": "failed to connect",
    "status_code": 502,
    "url": "https://www.example.com"
}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

hook_id

integer

required

The unique identifier of the hook.

delivery_id

integer

required

Responses

🟢200Response

application/json

Body

Delivery made by a webhook.

action

string | null

required

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

Example:

opened

delivered_at

string <date-time>

required

Time when the delivery was delivered.

Example:

2021-05-12T20:33:44.000Z

duration

number

required

Time spent delivering.

Example:

0.03

event

string

required

The event that triggered the delivery.

Example:

issues

guid

string

required

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

Example:

58474f00-b361-11eb-836d-0e4f3503ccbe

integer

required

Unique identifier of the delivery.

Example:

installation_id

integer | null

required

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

Example:

123

redelivery

boolean

required

Whether the delivery is a redelivery.

Example:

false

repository_id

integer | null

required

The id of the repository associated with this event.

Example:

123

request

object

required

headers

object | null

required

The request headers sent with the webhook delivery.

payload

object | null

required

The webhook payload.

response

object

required

headers

object | null

required

The response headers received when the delivery was made.

payload

string | null

required

The response payload received.

status

string

required

Description of the status of the attempted delivery

Example:

failed to connect

status_code

integer

required

Status code received when delivery was made.

Example:

502

url

string

optional

The URL target of the delivery.

Example:

https://www.example.com

🟠400400

🟠422422

Modified at 2023-08-15 02:59:24

List deliveries for a repository webhook

Redeliver a delivery for a repository webhook