Required Fields
No required fields are declared on this component schema.JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ApiResponseWebhookEndpointArray",
"description": "API response containing your webhook delivery endpoints.",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"description": "A delivery destination. The signing secret is not part of this shape: it is returned once when the endpoint is created and again when it is rotated, and never on a list.",
"type": "object",
"required": [
"consecutive_failures",
"created_at",
"description",
"id",
"status",
"url"
],
"properties": {
"consecutive_failures": {
"description": "Failed attempts since the last success. Resets to zero on a delivery that lands.",
"type": "integer",
"format": "int32",
"example": 0
},
"created_at": {
"description": "When the endpoint was created.",
"type": "string",
"format": "date-time"
},
"description": {
"description": "Your own label for the endpoint.",
"type": "string",
"example": "Trading desk alerts"
},
"id": {
"description": "Endpoint identifier.",
"type": "string",
"format": "uuid"
},
"status": {
"description": "`active` is serving. `disabled` means you switched it off. `auto_disabled` means a long run of failed deliveries switched it off for you; bring it back with the enable route.",
"type": "string",
"enum": [
"active",
"disabled",
"auto_disabled"
],
"example": "active"
},
"url": {
"description": "HTTPS destination that receives deliveries.",
"type": "string",
"format": "uri",
"example": "https://example.com/hooks/0xarchive"
}
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}