Request

Hotpot's API for tracking asynchronous actions

The Request API allows you to track the status of API calls you have already made, but which are asynchronous and don't return results immediately. Using the request ID you received from the original call, you can check the status of your request and potentially other things about it, depending on the type of request.

Get the status of a request

GET /request/:request_id/status

Get the processing status of an issued asynchronous request, like a page. The request_id in the URL is the v4 UUID you got back from the original Hotpot API call.

Headers

Name	Value
Authorization	Bearer <token>

Response

200

 {
    "response": {
      "message_request_id":"<hotpot request ID>",
      "status": "accepted",
      "status_message": "Page queued for delivery!",
      "errors": [],
      "message_id": "<message ID>"
    }
  } 

404

[]