BrewForge Docs

Post a feature request, question or reply in Feedback

Write in BrewForge's public Feedback board under the user's public username. PUBLIC: show the user the exact title and text and get their OK before calling; never post on your own initiative. New thread: category ("feature" or "question"), title and body. The tool first checks for similar existing threads: when it finds some it does NOT post and returns them, so you can vote there instead (react_to_feedback) or call again with skip_duplicate_check: true if the user still wants a new thread. Reply: pass thread (number) and body, e.g. { "thread": 33, "body": "+1, I need this for decoction mashes." }. Posting limits: accounts younger than 7 days cannot post; free plan 3 threads / 10 replies per month, paid plans 3 threads / 30 replies per day. Scope: `community:write` (or `write`).

POST
/api/v1/actions/post_feedback

Write in BrewForge's public Feedback board under the user's public username. PUBLIC: show the user the exact title and text and get their OK before calling; never post on your own initiative. New thread: category ("feature" or "question"), title and body. The tool first checks for similar existing threads: when it finds some it does NOT post and returns them, so you can vote there instead (react_to_feedback) or call again with skip_duplicate_check: true if the user still wants a new thread. Reply: pass thread (number) and body, e.g. { "thread": 33, "body": "+1, I need this for decoction mashes." }. Posting limits: accounts younger than 7 days cannot post; free plan 3 threads / 10 replies per month, paid plans 3 threads / 30 replies per day.

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

thread?|

Reply to this thread. The feedback thread: its number (33, "#33") or its URL (e.g. "https://brewforge.sh/feedback/33-water-per-mash-step"). Find numbers with find_feedback_threads. Omit to start a new thread.

category?string

New thread only (required): feature (feature request) or question.

Value in"feature" | "question"
title?string

New thread only (required): 8-140 characters, e.g. "Water chemistry per mash step".

Lengthlength <= 140
body*string

The text (Markdown), 1-10000 characters, in the user's words.

Lengthlength <= 10000
handle?string

Only needed for the user's very first post when they have no public handle (username) yet (the error says so): 3-30 letters, digits, _ or .. Ask the user.

Lengthlength <= 30
skip_duplicate_check?boolean

New thread only: post even though similar threads exist (after the user saw them).

[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/post_feedback" \  -H "Content-Type: application/json" \  -d '{    "body": "string"  }'
{
  "posted": true,
  "thread": 0,
  "url": "string",
  "reply_id": "string",
  "moderation": "published",
  "moderation_reason": "string",
  "similar_threads": [
    {
      "number": 0,
      "title": "string",
      "status": "string",
      "votes": 0,
      "you_voted": true,
      "url": "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": {}
  }
}