Add a fermentation device
Register a hydrometer or sensor so it can send readings: returns the webhook URL to enter in the device (BrewBrain: the token) and setup_steps saying what to enter where. The URL contains the device's secret key and is shown only here, so pass it on to the brewer. Then attach the device to a brew with update_device (brew). Types: ispindel, tilt, tilt_bridge (Tilt Pi / bridge; its Tilts appear by themselves), rapt, hydrom, gravitymon, brewbrain, plaato_airlock. Custom streams are set up in the app. Needs the plan feature `device_integrations`. Scope: `brews:write` (or `write`).
Register a hydrometer or sensor so it can send readings: returns the webhook URL to enter in the device (BrewBrain: the token) and setup_steps saying what to enter where. The URL contains the device's secret key and is shown only here, so pass it on to the brewer. Then attach the device to a brew with update_device (brew). Types: ispindel, tilt, tilt_bridge (Tilt Pi / bridge; its Tilts appear by themselves), rapt, hydrom, gravitymon, brewbrain, plaato_airlock. Custom streams are set up in the app.
Needs the plan feature device_integrations. Scope: brews:write (or write).
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 brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: brews:write
Request Body
application/json
Device type, e.g. "ispindel".
"ispindel" | "tilt" | "tilt_bridge" | "rapt" | "hydrom" | "gravitymon" | "brewbrain" | "plaato_airlock"Name to recognise it, e.g. "iSpindel blue".
1 <= length <= 80Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/add_device" \ -H "Content-Type: application/json" \ -d '{ "type": "ispindel", "name": "string" }'{
"device": {
"id": "string",
"name": "string",
"type": "string",
"brew": {
"id": "string",
"name": "string",
"status": "string"
},
"logs_keg": true,
"gravity_offset_sg": 0,
"last_seen_at": "string",
"last_gravity_sg": 0,
"last_temp_c": 0,
"last_battery": 0
},
"webhook_url": "string",
"token": "string",
"setup_steps": [
"string"
],
"setup_note": "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": {}
}
}