Skip to content

HttpEvent

export interface HttpEvent {

HTTP response payload delivered to BackgroundGeolocation.onHttp.

The SDK fires this event after every upload attempt — whether the request succeeded or failed. Use it to inspect the server response, handle errors, or trigger follow-up logic in your app.

BackgroundGeolocation.onHttp((event) => {
  if (event.success) {
    console.log("[onHttp] Upload succeeded:", event.status);
  } else {
    console.warn("[onHttp] Upload failed:", event.status, event.responseText);
  }
});

Members

responseText

responseText: string;

Raw response body returned by the server.

Parse this string to extract server-side data, error messages, or remote-control commands embedded in the response.

status

status: number;

HTTP status code returned by the server (e.g. 200, 201, 404, 500).

success

success: boolean;

true when the server returned a 2xx status code.