GET /status

Get status updates (delivered via webhook events)

Responses

  • 200 application/json

    Status updates info retrieved

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • data object
      Hide data attribute Show data attribute object
      • info string
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
GET /status
curl \
 --request GET 'http://localhost:7001/status' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "code": 200,
  "data": {
    "info": "Configure a webhook to receive status.posted, status.viewed, and status.deleted events"
  },
  "status": true,
  "message": "Status updates are delivered via webhook events"
}
Response examples (200)
{
  "status": true,
  "code": 200,
  "message": "Status updates are delivered via webhook events",
  "data": {
    "info": "Configure a webhook to receive status.posted, status.viewed, and status.deleted events"
  }
}
Response examples (401)
{
  "code": 401,
  "error": "Invalid or expired JWT token",
  "status": false,
  "message": "Unauthorized"
}
Response examples (401)
{
  "status": false,
  "code": 401,
  "message": "Unauthorized",
  "error": "Invalid or missing authentication"
}
Response examples (500)
{
  "code": 500,
  "error": "Failed to retrieve status updates info",
  "status": false,
  "message": "Internal server error"
}
Response examples (500)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}