Skip to content

Hydrobit API (2.0.0)

Comprehensive API documentation for the Hydrobit platform.

This API enables management of forms, records, workers, projects, and related data within Hydrobit.

Authentication

  • User endpoints: Require a JWT in the Authorization header (Bearer token).

Features

  • Form management and record submission
  • Project and sector data retrieval
  • Worker management and operations
  • Production session and record management

Note: API access is available for Corporate accounts. For access or support, contact support@hydrobit.ag.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://hydrobit.ag
Hydrobit Support
support@hydrobit.ag
License
Proprietary
Languages
Servers
Mock server
https://docs.hydrobit.ag/_mock/spec/openapi/
Production server
https://api.hydrobit.ag/
IoT server
https://iot.hydrobit.ag/
MQTT over WebSocket endpoint
wss://iot.hydrobit.ag/

Forms

Endpoints for form management and record submission

Operations

Get forms for a user

Request

Retrieves all forms accessible to a user based on their company context.

Requires JWT token authentication in the Authorization header.

  • If subtype=tasks, returns all task forms for the user
  • Otherwise, returns monitoring forms based on user access permissions
Security
bearerAuth
Query
auth0Idstringrequired

User identifier

Example: auth0Id=user_123456789
companyIdstringrequired

Company identifier

Example: companyId=comp_12345
typestring

Form type filter

Example: type=inspection
subtypestring

Form subtype (e.g., 'tasks' for task forms)

Example: subtype=tasks
curl -i -X GET \
  'https://docs.hydrobit.ag/_mock/spec/openapi/api/control/forms/getForms?auth0Id=user_123456789&companyId=comp_12345&type=inspection&subtype=tasks' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Forms retrieved successfully

Bodyapplication/json
statusstring
Example: "success"
dataArray of objects(Form)
Response
application/json
{
  "status": "success",
  "data": [
    { … }
  ]
}

Submit a form record

Request

Submits a new form record with field values and location data.

This endpoint:

  • Validates the record data
  • Processes form field values
  • Determines location (project/sector) using GPS or forced location
  • Saves data to persistent storage
  • Uploads media files (photos, audio, signatures) to cloud storage
  • Updates task status if applicable
Security
bearerAuth
Bodyapplication/jsonrequired
recordobject(Record)required
record.​_idstringrequired

Form ID (not the record ID)

Example: "form_abc123"
record.​auth0Idstringrequired

User identifier

Example: "user_123456789"
record.​typestringrequired

Record type

Example: "inspection"
record.​latitudenumber(double)

GPS latitude

Example: 19.4326
record.​longitudenumber(double)

GPS longitude

Example: -99.1332
record.​form_idstring

Form identifier

Example: "form_abc123"
record.​form_valuesArray of objects

Array of form field values

record.​iniciostring(date-time)

Record start time

Example: "2025-10-09T10:00:00Z"
record.​segundosnumber

Time spent on record (in seconds)

Example: 120
curl -i -X POST \
  https://docs.hydrobit.ag/_mock/spec/openapi/api/control/forms/record \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "record": {
      "_id": "form_abc123",
      "auth0Id": "user_123456789",
      "type": "inspection",
      "latitude": 19.4326,
      "longitude": -99.1332,
      "form_id": "form_abc123",
      "form_values": [
        {
          "field_temp": "25"
        },
        {
          "field_notes": "All looking good"
        }
      ],
      "inicio": "2025-10-09T10:00:00Z",
      "segundos": 120
    }
  }'

Responses

Record created successfully

Bodyapplication/json
statusstring
Example: "success"
verificationobject
Response
application/json
{
  "status": "success",
  "verification": {
    "project": true,
    "sector": true
  }
}

Projects

Endpoints for project and sector data retrieval

Operations

Workers

Endpoints for worker management and operations

Operations

Production Sessions

Endpoints for managing production sessions (open, close, update)

Operations

Production Records

Endpoints for creating and managing production records

Operations

Phytosanitary

Endpoints for phytosanitary monitoring and analysis (pest/disease tracking)

Operations

Weather

Endpoints for weather and climate data retrieval

Operations

Plant

Endpoints for plant monitoring, growth, and health data

Operations

Irrigation

Endpoints for irrigation control, logs, and automation

Operations

IoT Endpoint

Endpoints for IoT devices, telemetry, and field data integration

Operations