BrewForge Docs

Report a problem to support, or reply on a ticket

Support tickets are for bugs: something in BrewForge is broken or wrong. Feature wishes go to Feedback (post_feedback), questions on how to use BrewForge too. New bug report: title, details, severity, e.g. { "title": "Brew day timer stops when the phone locks", "details": "Steps: ...", "severity": "medium" }. Reply on an existing ticket: ticket + message, e.g. { "ticket": 412, "message": "It happens on Android too." }. The BrewForge team reads every ticket and answers in the inbox (get_inbox). Confirm the text with the user before sending. Limit: 5 reports per hour, 10 per day. Screenshots can't be attached here; the user can add them in the app. Scope: `community:write` (or `write`).

POST
/api/v1/actions/contact_support

Support tickets are for bugs: something in BrewForge is broken or wrong. Feature wishes go to Feedback (post_feedback), questions on how to use BrewForge too. New bug report: title, details, severity, e.g. { "title": "Brew day timer stops when the phone locks", "details": "Steps: ...", "severity": "medium" }. Reply on an existing ticket: ticket + message, e.g. { "ticket": 412, "message": "It happens on Android too." }. The BrewForge team reads every ticket and answers in the inbox (get_inbox). Confirm the text with the user before sending. Limit: 5 reports per hour, 10 per day. Screenshots can't be attached here; the user can add them in the app.

Scope: community: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: community:write

Request Body

application/json

ticket?|

Reply on this ticket. The support ticket: its number (412 or "#412") or id, from get_inbox. Omit to report a new problem.

message?string

Reply only (required): the user's answer to the team.

Lengthlength <= 5000
title?string

New report (required): what the user was trying to do / what broke, max 200 characters, e.g. "Brew day timer stops when the phone locks".

Lengthlength <= 200
details?string

New report: steps to reproduce, what was expected, what happened (max 2000 characters).

Lengthlength <= 2000
severity?string

New report: minor (cosmetic), medium (default; something doesn't work) or blocking (can't continue).

Value in"minor" | "medium" | "blocking"
page?string

New report: where in BrewForge it happens, a URL path or screen name, e.g. "/brews/123" or "brew day timer".

Lengthlength <= 500
brew?string

New report: the brew it is about, if any. The brew: its id, its batch number (e.g. 12 or "#12") or its exact name (e.g. "Citra Pale Ale"). Case does not matter.

not_a_feature_request?boolean

New report: set true when the first call said it looks like a feature request but the user confirms it is a bug.

[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/contact_support" \  -H "Content-Type: application/json" \  -d '{}'
{
  "status": "created",
  "ticket": {
    "id": "string",
    "number": 0,
    "status": "string"
  },
  "message": "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": {}
  }
}