Skip to content
forgit api docs

Get a delivery for an app webhook

GET
/app/hook/deliveries/{delivery_id}

Returns a delivery for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
delivery_id
required
integer

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Webhook delivery

Delivery made by a webhook.

object
id
required

Unique identifier of the delivery.

integer
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 delivery was delivered.

string format: date-time
redelivery
required

Whether the delivery is a redelivery.

boolean
duration
required

Time spent delivering.

number
status
required

Description of the status of the attempted 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
nullable
repository_id
required

The id of the repository associated with this event.

integer
nullable
throttled_at

Time when the webhook delivery was throttled.

string format: date-time
nullable
url

The URL target of the delivery.

string
request
required
object
headers
required

The request headers sent with the webhook delivery.

object
key
additional properties
any
payload
required

The webhook payload.

object
key
additional properties
any
response
required
object
headers
required

The response headers received when the delivery was made.

object
key
additional properties
any
payload
required

The response payload received.

string
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,
  "url": "https://www.example.com",
  "throttled_at": "2019-06-03T00:57:16Z",
  "request": {
    "headers": {
      "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
      "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
      "Accept": "*/*",
      "X-GitHub-Hook-ID": "42",
      "User-Agent": "GitHub-Hookshot/b8c71d8",
      "X-GitHub-Event": "issues",
      "X-GitHub-Hook-Installation-Target-ID": "123",
      "X-GitHub-Hook-Installation-Target-Type": "repository",
      "content-type": "application/json",
      "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
    },
    "payload": {
      "action": "opened",
      "issue": {
        "body": "foo"
      },
      "repository": {
        "id": 123
      }
    }
  },
  "response": {
    "headers": {
      "Content-Type": "text/html;charset=utf-8"
    },
    "payload": "ok"
  }
}

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"
      ]
    }
  ]
}