APIs.io Engineering Platform · Schema
Webhook delivery
Delivery made by a webhook.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the delivery. |
| guid | string | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). |
| delivered_at | string | Time when the delivery was delivered. |
| redelivery | boolean | Whether the delivery is a redelivery. |
| duration | number | Time spent delivering. |
| status | string | Description of the status of the attempted delivery |
| status_code | integer | Status code received when delivery was made. |
| event | string | The event that triggered the delivery. |
| action | string | The type of activity for the event that triggered the delivery. |
| installation_id | integer | The id of the GitHub App installation associated with this event. |
| repository_id | integer | The id of the repository associated with this event. |
| throttled_at | string | Time when the webhook delivery was throttled. |
| url | string | The URL target of the delivery. |
| request | object | |
| response | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/hook-delivery",
"title": "Webhook delivery",
"description": "Delivery made by a webhook.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the delivery.",
"type": "integer",
"example": 42
},
"guid": {
"description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).",
"type": "string",
"example": "58474f00-b361-11eb-836d-0e4f3503ccbe"
},
"delivered_at": {
"description": "Time when the delivery was delivered.",
"type": "string",
"format": "date-time",
"example": "2021-05-12T20:33:44Z"
},
"redelivery": {
"description": "Whether the delivery is a redelivery.",
"type": "boolean",
"example": false
},
"duration": {
"description": "Time spent delivering.",
"type": "number",
"example": 0.03
},
"status": {
"description": "Description of the status of the attempted delivery",
"type": "string",
"example": "failed to connect"
},
"status_code": {
"description": "Status code received when delivery was made.",
"type": "integer",
"example": 502
},
"event": {
"description": "The event that triggered the delivery.",
"type": "string",
"example": "issues"
},
"action": {
"description": "The type of activity for the event that triggered the delivery.",
"type": "string",
"example": "opened",
"nullable": true
},
"installation_id": {
"description": "The id of the GitHub App installation associated with this event.",
"type": "integer",
"example": 123,
"nullable": true
},
"repository_id": {
"description": "The id of the repository associated with this event.",
"type": "integer",
"example": 123,
"nullable": true
},
"throttled_at": {
"description": "Time when the webhook delivery was throttled.",
"type": "string",
"format": "date-time",
"example": "2021-05-12T20:33:44Z",
"nullable": true
},
"url": {
"description": "The URL target of the delivery.",
"type": "string",
"example": "https://www.example.com"
},
"request": {
"type": "object",
"properties": {
"headers": {
"description": "The request headers sent with the webhook delivery.",
"type": "object",
"nullable": true,
"additionalProperties": true
},
"payload": {
"description": "The webhook payload.",
"type": "object",
"nullable": true,
"additionalProperties": true
}
},
"required": [
"headers",
"payload"
]
},
"response": {
"type": "object",
"properties": {
"headers": {
"description": "The response headers received when the delivery was made.",
"type": "object",
"nullable": true,
"additionalProperties": true
},
"payload": {
"description": "The response payload received.",
"type": "string",
"nullable": true,
"additionalProperties": true
}
},
"required": [
"headers",
"payload"
]
}
},
"required": [
"id",
"guid",
"delivered_at",
"redelivery",
"duration",
"status",
"status_code",
"event",
"action",
"installation_id",
"repository_id",
"request",
"response"
]
}