Webhooks

List webhook attempts

get/nhsapi/v1/Webhooks/{id}/attempts

Request

  • Base URL: https://www.example.com
  • URL: https://www.example.com/nhsapi/v1/Webhooks/{id}/attempts
  • Auth: none declared

Query parameters

successstring

Filter by success status (true/false)

pageinteger

Page number

per_pageinteger

Items per page (default 100)

Headers

X-External-Account-Tokenstring

External account token for authentication

Response

attempts listed

Example response

{
  "attempts": [
    {
      "id": 1,
      "event_data": {
        "event_type": "booking_created",
        "booking_id": 123
      },
      "status_code": 200,
      "response_body": "OK",
      "success": true
    }
  ],
  "meta": {
    "total": 50,
    "page": 1,
    "per_page": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.