BrewForge Docs

Inbox: support tickets, team messages and notifications

The user's inbox: how many things need attention, their support tickets (open by default) with unread team replies, messages from the BrewForge team, Feedback notifications (replies and status changes on followed threads) and community notices (new followers, cheers). Answers "did support answer my ticket?". With ticket (e.g. { "ticket": 412 }): that ticket with the whole conversation. Reading does not mark anything as read; use mark_inbox_read for that, and contact_support to reply on a ticket. Scope: `community:read` (or `read`).

POST
/api/v1/actions/get_inbox

The user's inbox: how many things need attention, their support tickets (open by default) with unread team replies, messages from the BrewForge team, Feedback notifications (replies and status changes on followed threads) and community notices (new followers, cheers). Answers "did support answer my ticket?". With ticket (e.g. { "ticket": 412 }): that ticket with the whole conversation. Reading does not mark anything as read; use mark_inbox_read for that, and contact_support to reply on a ticket.

Scope: community:read (or read).

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:read

Request Body

application/json

ticket?|

Show this ticket with its messages. The support ticket: its number (412 or "#412") or id, from get_inbox.

tickets?string

Which tickets to list (default open).

Value in"open" | "closed" | "all"
include?array<>

Sections to return (default all): tickets, messages (from the team), feedback (notifications), community (notices).

[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/get_inbox" \  -H "Content-Type: application/json" \  -d '{}'
{
  "needs_attention": 0,
  "tickets": [
    {
      "id": "string",
      "number": 0,
      "title": "string",
      "status": "string",
      "severity": "string",
      "unread_reply": true,
      "bounty_points": 0,
      "milestone": "string",
      "last_activity": "string"
    }
  ],
  "messages": {
    "unread": 0,
    "archived": 0,
    "items": [
      {
        "id": "string",
        "subject": "string",
        "body": "string",
        "truncated": true,
        "read": true,
        "date": "string",
        "from": "string"
      }
    ]
  },
  "feedback_notifications": {
    "unread": 0,
    "items": [
      {
        "id": "string",
        "type": "string",
        "read": true,
        "date": "string",
        "thread": 0,
        "title": "string",
        "by": "string",
        "new_status": "string",
        "url": "string"
      }
    ]
  },
  "community_notices": {
    "unread": 0,
    "items": [
      {
        "kind": "string",
        "date": "string",
        "by": "string",
        "beer": "string",
        "count": 0
      }
    ]
  },
  "ticket": {
    "id": "string",
    "number": 0,
    "title": "string",
    "status": "string",
    "severity": "string",
    "unread_reply": true,
    "bounty_points": 0,
    "milestone": "string",
    "last_activity": "string",
    "team_replied": true,
    "details": "string",
    "page": "string",
    "created": "string",
    "messages": [
      {
        "from": "you",
        "name": "string",
        "body": "string",
        "truncated": true,
        "date": "string",
        "attachments": 0
      }
    ]
  }
}
{
  "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": {}
  }
}