HttpConfig class

HTTP / Networking Configuration

The HttpConfig group controls how recorded locations are uploaded to your server. It defines the endpoint, HTTP verb, headers and params, batching behavior, and request timeouts. These options apply to all automatic syncs as well as manual syncs triggered by the app.

BackgroundGeolocation.ready(Config(
  http: HttpConfig(
    url: 'https://example.com/locations',
    autoSync: true,
    params: {
      "user_id": 1234
    }
  }
));

Overview

The SDK persistently stores each recorded location in its internal SQLite database before attempting to upload it. The HTTP Service continuously consumes this queue of stored records in the background. For each record, the service acquires a record-level lock to prevent concurrent or duplicate uploads, serializes the record into an HTTP request, and posts it to the configured url. If the server responds with any 2xx status code, the record is considered successfully delivered and is deleted from the SQLite database. Failed or timed-out uploads remain locked until released, after which they are retried later when network conditions improve.

The uploader operates automatically and reliably across background execution, app termination, and device reboot. When connectivity returns, it resumes processing any remaining records in the queue to maintain delivery integrity.

How uploads work

1. Each recorded location is persisted to SQLite.
2. The HTTP Service locks pending records to prevent duplicate uploads.
3. Locked records are serialized and sent to the configured url.
4. On a successful 2xx response, uploaded records are deleted.
5. Failed or timed-out records are unlocked and retried later.

The SQLite buffer

The database is a durable, rolling buffer. It prefers to be empty. Records are removed when:

• Your server returns a 2xx (see HttpEvent).
• You call BackgroundGeolocation.destroyLocations.
• PersistenceConfig.maxDaysToPersist expires (rolling TTL).
• PersistenceConfig.maxRecordsToPersist would be exceeded (oldest dropped).

Inspect the queue with BackgroundGeolocation.count and fetch with BackgroundGeolocation.locations.

Payload composition

• Body: Location uploads are JSON. If batchSync is true, an array of records is sent. If rootProperty is set, the payload becomes { "<rootProperty>": [...] }.

• Headers: Merged from HttpConfig.headers (and authorization when configured). For authorization refresh requests, see the Authorization docs; those use their own Content-Type.

• Params: Key/value pairs merged into each outgoing payload (at the root or under rootProperty).

The SDK applies an appropriate JSON content type for location uploads; authorization refresh requests use application/x-www-form-urlencoded.

Sync strategy

• autoSync: Upload immediately after each record.
• autoSyncThreshold: Wait until N records before auto-syncing.
• batchSync: Combine multiple records into one request.
• maxBatchSize: Limit records per request.
• timeout: Max request duration (ms).
• disableAutoSyncOnCellular: Queue until Wi-Fi is available.

Note: If autoSyncThreshold is set, it is ignored during BackgroundGeolocation.onMotionChange transitions so that state changes are not delayed.

Error handling & retries

On non-2xx responses or connection failures, records remain in the local queue. The uploader retries automatically when conditions improve. Triggers include:

• A new location recorded
• App lifecycle changes (pause/resume, boot)
• BackgroundGeolocation.onConnectivityChange events
• BackgroundGeolocation.onHeartbeat ticks
• iOS background fetch

You can also call BackgroundGeolocation.sync manually at any time.

HTTP Logging

You can observe the SDK performing HTTP in the logs (see the Debugging guide). Example:

╔═════════════════════════════════════════════
║ LocationService: location
╠═════════════════════════════════════════════
╟─ 📍 Location[45.519199,-73.617054]
✅ INSERT: 70727f8b-df7d-48d0-acbd-15f10cacdf33
╔═════════════════════════════════════════════
║ HTTP Service
╠═════════════════════════════════════════════
✅ Locked 1 records
🔵 HTTP POST: 70727f8b-df7d-48d0-acbd-15f10cacdf33
🔵 Response: 200
✅ DESTROY: 70727f8b-df7d-48d0-acbd-15f10cacdf33

Remote control via HTTP response (RPC)

Your server can remotely invoke SDK commands by returning a JSON body containing a background_geolocation payload. The SDK scans the JSON and executes commands synchronously upon receipt of the HTTP response.

Shape (multiple commands):

{
  "background_geolocation": [
    ["command1", <optional argument>],
    ["command2"]
  ]
}

Shape (single command):

{
  "background_geolocation": ["stop"]
}

Supported commands

Examples

Stop the SDK:

{ "background_geolocation": ["stop"] }

Change pace:

{ "background_geolocation": ["changePace", true] }

Update configuration (compound form):

{
  "background_geolocation": [
    "setConfig",
    {
      "geolocation": { "distanceFilter": 25, "desiredAccuracy": 3 },
      "http": { "autoSync": true, "batchSync": true, "maxBatchSize": 50 }
    }
  ]
}

Examples

Simple configuration (immediate uploads)

import 'package:flutter_background_geolocation/flutter_background_geolocation.dart' as bg;

final config = bg.Config(
  http: bg.HttpConfig(
    url: 'https://api.example.com/locations',
    method: 'POST',
    autoSync: true,
    batchSync: false,
    timeout: 60000,
    headers: {'Authorization': 'Bearer secret-token'},
    params: {'device_id': 'abc-123'},
  ),
);

Batched uploads with threshold

final config = bg.Config(
  http: bg.HttpConfig(
    url: 'https://api.example.com/locations/bulk',
    autoSync: true,
    batchSync: true,
    maxBatchSize: 25,
    autoSyncThreshold: 10,
    rootProperty: 'locations',
  ),
);

Conserve cellular data

final config = bg.Config(
  http: bg.HttpConfig(
    url: 'https://api.example.com/locations',
    autoSync: true,
    disableAutoSyncOnCellular: true,
  ),
);

Manual sync

await bg.BackgroundGeolocation.setConfig(bg.Config(
  http: bg.HttpConfig(
    url: 'https://api.example.com/locations',
    autoSync: false,
  ),
));

await bg.BackgroundGeolocation.sync();

Migration from legacy flat Config

Previously, HTTP parameters were defined directly on Config:

// Legacy
Config(
  url: 'https://api.example.com',
  autoSync: true,
  headers: {'Authorization': 'Bearer ...'},
);

They are now grouped under HttpConfig via Config.http:

// New
Config(
  http: HttpConfig(
    url: 'https://api.example.com',
    autoSync: true,
    headers: {'Authorization': 'Bearer ...'},
  ),
);

Legacy keys remain available but are marked @Deprecated and will be removed in a future major release. Prefer the new compound form.