events

Lists all SystemEvents in the system.

get/api/events

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in cookie sessionid

Query parameters

cursorstring

The pagination cursor value.

keginteger
kind'drink_poured' | 'keg_ended' | 'keg_tapped' | 'keg_volume_low' | 'session_joined' | 'session_started'

Type of event.

  • drink_poured - Drink poured
  • session_started - Session started
  • session_joined - User joined session
  • keg_tapped - Keg tapped
  • keg_volume_low - Keg volume low
  • keg_ended - Keg ended
page_sizeinteger

Number of results to return per page.

sessioninteger
sinceinteger
userinteger
usernamestring

Response

nextstring uri nullable
previousstring uri nullable

Example response

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
}

Changes

    • info

      removed the required write-only property results/items/drink/allOf[Drink]/keg/allOf[Keg]/beverage/allOf[Beverage]/producer_id from the response with the status

    • info

      removed the required write-only property results/items/keg/allOf[Keg]/beverage/allOf[Beverage]/producer_id from the response with the status