Skip to content
forgit api docs

List deliveries for an app webhook

GET
/app/hook/deliveries

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

API method documentation

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
per_page
integer
default: 30

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

cursor
string

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.

status
string
Allowed values: success failure

Returns webhook deliveries filtered by delivery outcome classification based on status_code range. A status of success returns deliveries with a status_code in the 200-399 range (inclusive). A status of failure returns deliveries with a status_code in the 400-599 range (inclusive).

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Array<object>
Simple webhook delivery

Delivery made by a webhook, without request and response information.

object
id
required

Unique identifier of the webhook delivery.

integer format: int64
guid
required

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

string
delivered_at
required

Time when the webhook delivery occurred.

string format: date-time
redelivery
required

Whether the webhook delivery is a redelivery.

boolean
duration
required

Time spent delivering.

number
status
required

Describes the response returned after attempting the delivery.

string
status_code
required

Status code received when delivery was made.

integer
event
required

The event that triggered the delivery.

string
action
required

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

string
nullable
installation_id
required

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

integer format: int64
nullable
repository_id
required

The id of the repository associated with this event.

integer format: int64
nullable
throttled_at

Time when the webhook delivery was throttled.

string format: date-time
nullable
Examples
Example default 
[
  {
    "id": 12345678,
    "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
    "delivered_at": "2019-06-03T00:57:16Z",
    "redelivery": false,
    "duration": 0.27,
    "status": "OK",
    "status_code": 200,
    "event": "issues",
    "action": "opened",
    "installation_id": 123,
    "repository_id": 456,
    "throttled_at": "2019-06-03T00:57:16Z"
  },
  {
    "id": 123456789,
    "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
    "delivered_at": "2019-06-04T00:57:16Z",
    "redelivery": true,
    "duration": 0.28,
    "status": "OK",
    "status_code": 200,
    "event": "issues",
    "action": "opened",
    "installation_id": 123,
    "repository_id": 456,
    "throttled_at": null
  }
]

400

Section titled “ 400 ”

Bad Request

Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “ 422 ”

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}