BrewForge Docs

Taps: put a beer on, next up, add/rename taps

Works with the taps of a tap list. action: put_on = the beer pours from this tap now; next_up = the beer comes on this tap next; promote = the next-up beer goes on now (keg changed); clear = nothing pours from the tap; clear_next_up; create = new tap (name); rename (name); enable / disable; move (position, 1 = first). Example: "put the porter on tap 2 and make the saison next up" = two calls: {"tap":"Tap 2","action":"put_on","beer":"Porter"} then {"tap":"Tap 2","action":"next_up","beer":"Saison"}. beer is a beer on the list or a brew (added to the list automatically). tap is the tap's name or id ("2" finds "Tap 2"). Returns all taps of the list. Needs the plan feature `taplist`. Scope: `cellar:write` (or `write`).

POST
/api/v1/actions/manage_tap

Works with the taps of a tap list. action: put_on = the beer pours from this tap now; next_up = the beer comes on this tap next; promote = the next-up beer goes on now (keg changed); clear = nothing pours from the tap; clear_next_up; create = new tap (name); rename (name); enable / disable; move (position, 1 = first). Example: "put the porter on tap 2 and make the saison next up" = two calls: {"tap":"Tap 2","action":"put_on","beer":"Porter"} then {"tap":"Tap 2","action":"next_up","beer":"Saison"}. beer is a beer on the list or a brew (added to the list automatically). tap is the tap's name or id ("2" finds "Tap 2"). Returns all taps of the list.

Needs the plan feature taplist. Scope: cellar:write (or write).

AuthorizationBearer <token>

API token in format: bfk_. Each operation lists the token scope it requires (the scopes are listed below).

  • read: Read everything (all areas)
  • write: Create, change and delete everything (all areas)
  • brews:read: List and view brews
  • brews:write: Create, update, delete brews and notes
  • inventory:read: List inventory items
  • inventory:write: Create, update, delete inventory items
  • equipment:read: List equipment profiles
  • equipment:write: Create, update, delete equipment profiles
  • styles:read: List style profiles
  • styles:write: Create, update, delete style profiles
  • profiles:read: List mash, fermentation, and water profiles
  • custom-fields:read: List custom field definitions
  • custom-fields:write: Create, update, delete custom field definitions
  • profiles:write: Create, update, delete mash, fermentation, and water profiles
  • cellar:read: View cellar, packaged stock, tap lists, and labels
  • cellar:write: Manage cellar, packaging, stock, tap lists, and labels
  • settings:read: View preferences, imports, calculators, and your data export
  • settings:write: Change preferences and undo imports
  • community:read: View community, feedback, tickets, inbox, and account overview
  • community:write: Post, vote, and reply in community, feedback, and tickets

In: header

Scope: cellar:write

Request Body

application/json

list?string

The tap list: its id or exact name (e.g. "Taproom"). Optional when the brewer has only one tap list.

action*string

put_on, next_up, promote, clear, clear_next_up, create, rename, enable, disable or move.

Value in"put_on" | "next_up" | "promote" | "clear" | "clear_next_up" | "create" | "rename" | "enable" | "disable" | "move"
tap?string

The tap: name or id, e.g. "Tap 2". Not needed for create.

beer?string

put_on / next_up: the beer (name on the list, or a brew name / batch number), e.g. "Porter".

name?string

create / rename: the tap name, e.g. "Tap 3" or "Nitro".

Length1 <= length <= 100
position?integer

move: new place, 1 = first.

Range1 <= value
[key: string]?never

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://brewforge.sh/api/v1/actions/manage_tap" \  -H "Content-Type: application/json" \  -d '{    "action": "put_on"  }'
{
  "list": "string",
  "tap": "string",
  "added_to_list": "string",
  "taps": [
    {
      "id": "string",
      "name": "string",
      "enabled": true,
      "pouring": "string",
      "next_up": "string"
    }
  ]
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}