v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Warm up authorisation control webhook

Warm-up endpoint for initialising WebClient

This is not an endpoint. This is the description of the request that is warming up the WebClient. It sends a lightweight JSON message to initialise network connections and reduce latency for subsequent API requests.

post/warm-up

Headers

X-WarmUpboolean required
Example:true

Identifies the request as a warm-up call.

Request body

typestring required

Indicates the type of message. For warm-up, this value is "WARM_UP".

timestampstring date-time required

The timestamp when the message was created.

Example request

{
  "type": "WARM_UP",
  "timestamp": "2021-09-01T12:00:00Z"
}

Response

Response will be ignored