Realtime Approval Subscription

List active realtime subscriptions

{
  "data": [
    {
      "channel_id": "chan_b5c6d7e8",
      "subscription_type": "organisation_claims",
      "organisation_id": "org_001",
      "user_id": "usr_coord99",
      "status": "connected",
      "created_at": "2026-03-26T08:00:00Z",
      "last_event_at": "2026-03-26T08:14:22Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 3
  }
}

Get subscription channel status and stats

{
  "channel_id": "chan_b5c6d7e8",
  "subscription_type": "organisation_claims",
  "organisation_id": "org_001",
  "user_id": "usr_coord99",
  "status": "connected",
  "event_count": 14,
  "websocket_url": "wss://realtime.example.com/channels/chan_b5c6d7e8",
  "created_at": "2026-03-26T08:00:00Z",
  "last_event_at": "2026-03-26T08:14:22Z"
}

Subscribe to all claim events in an organisation (subscribeToOrganisationClaims)

{
  "organisation_id": "org_001",
  "user_id": "usr_coord99",
  "event_types": [
    "status_changed",
    "claim_submitted",
    "claim_approved",
    "claim_rejected"
  ]
}

{
  "channel_id": "chan_b5c6d7e8",
  "subscription_type": "organisation_claims",
  "organisation_id": "org_001",
  "user_id": "usr_coord99",
  "websocket_url": "wss://realtime.example.com/channels/chan_b5c6d7e8",
  "status": "connected",
  "created_at": "2026-03-26T08:00:00Z"
}

Subscribe to a specific user's claim events (subscribeToUserClaims)

{
  "user_id": "usr_84cd12ef",
  "event_types": [
    "status_changed",
    "comment_added"
  ]
}

{
  "channel_id": "chan_f9g0h1i2",
  "subscription_type": "user_claims",
  "user_id": "usr_84cd12ef",
  "websocket_url": "wss://realtime.example.com/channels/chan_f9g0h1i2",
  "status": "connected",
  "created_at": "2026-03-26T08:00:00Z"
}

Reconnect a dropped channel and receive missed events (reconnect)

{
  "channel_id": "chan_b5c6d7e8",
  "status": "connected",
  "reconnected_at": "2026-03-26T09:15:00Z",
  "missed_events": 2
}

Unsubscribe and close a realtime channel (unsubscribe)

{
  "channel_id": "chan_b5c6d7e8",
  "unsubscribed": true,
  "closed_at": "2026-03-26T10:00:00Z"
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}