{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ApiResponseWebhookDryRun",
"description": "API response containing a subscription dry-run.",
"type": "object",
"properties": {
"data": {
"description": "Which occurrences in the requested window a would-be subscription would have delivered. Nothing is stored and no delivery is sent.",
"type": "object",
"required": [
"event_type",
"matched",
"occurrences",
"truncated",
"window"
],
"properties": {
"event_type": {
"description": "Event type that was evaluated.",
"type": "string",
"example": "market.liquidation"
},
"matched": {
"description": "Occurrences that matched inside the window, before `limit` is applied.",
"type": "integer",
"example": 37
},
"occurrences": {
"description": "Newest first, at most `limit`.",
"type": "array",
"items": {
"description": "One occurrence that would have been delivered, in the shape the delivered payload carries.",
"type": "object",
"required": [
"data",
"observed_at_estimate"
],
"properties": {
"data": {
"description": "The occurrence body, the same `data` a delivery would carry.",
"type": "object",
"additionalProperties": true
},
"observed_at_estimate": {
"description": "The occurrence's own timestamp. A real delivery's `observed_at` is this plus the time it takes to see the occurrence.",
"type": "string",
"format": "date-time"
}
}
}
},
"truncated": {
"description": "True when fewer occurrences are returned than matched, or when a scan hit its row cap and the window was narrowed.",
"type": "boolean",
"example": false
},
"window": {
"description": "The window a preview vouches for. It can start later than the one that was asked for when a scan reached its row cap.",
"type": "object",
"required": [
"from",
"to"
],
"properties": {
"from": {
"description": "Start of the window the answer covers.",
"type": "string",
"format": "date-time"
},
"to": {
"description": "End of the window, which is the moment of the request.",
"type": "string",
"format": "date-time"
}
}
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}