We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.
Livraisons de webhooks d’un dépôt
Utilisez l’API REST pour interagir avec les livraisons de webhooks de dépôt.
List deliveries for a repository webhook
Returns a list of webhook deliveries for a webhook configured in a repository.
Paramètres
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
hook_idintegerObligatoireThe unique identifier of the hook. |
| Paramètres de requête |
| Nom, Type, Description |
per_pageintegerThe number of results per page (max 100). Default: |
cursorstringUsed for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the |
redeliveryboolean |
Codes de statut de réponse HTTP
| Code d’état | Description |
|---|---|
200 | OK |
400 | Bad Request |
422 | Validation failed, or the endpoint has been spammed. |
Exemples de code
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/deliveriesResponse
Status: 200[
{
"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
},
{
"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
}
]Get a delivery for a repository webhook
Returns a delivery for a webhook configured in a repository.
Paramètres
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
hook_idintegerObligatoireThe unique identifier of the hook. |
delivery_idintegerObligatoire |
Codes de statut de réponse HTTP
| Code d’état | Description |
|---|---|
200 | OK |
400 | Bad Request |
422 | Validation failed, or the endpoint has been spammed. |
Exemples de code
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/deliveries/DELIVERY_IDResponse
Status: 200{
"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",
"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"
}
}Redeliver a delivery for a repository webhook
Redeliver a webhook delivery for a webhook configured in a repository.
Paramètres
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
hook_idintegerObligatoireThe unique identifier of the hook. |
delivery_idintegerObligatoire |
Codes de statut de réponse HTTP
| Code d’état | Description |
|---|---|
202 | Accepted |
400 | Bad Request |
422 | Validation failed, or the endpoint has been spammed. |
Exemples de code
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/deliveries/DELIVERY_ID/attemptsAccepted
Status: 202