Outbound Payloads

When you do beam up , Beam runs as a background daemon service. By default, the Beam daemon runs a HTTP server which includes a REST API. You can programmatically interact with Beam and the GRID network over this API.

Send a Package

POST /api/package

Sends a package synchronously.

Headers

Name	Value
Content-Type	application/json

Body

Field	Type	Description
id	Int32 (Optional)	Package id
channels	Array<Channel> (Optional)	Channels to send Package over. If none are provided, all channels are used.
collapseKey	Int32 (Optional)	If set, the given Package will replace any queued Packages that have a matching collapseKey. Use this to replace in-progress Packages with fresh data.
priority	Int32 (Optional)	Higher priority Packages will jump ahead of other Packages in the queue. Default is 11, Messages are 12, Locations are 10, Sos is 100.
data	Data (one-of type)	Present when sending a Data Package
message	Message (one-of type)	Present when sending a Message Package
location	Location (one-of type)	Present when sending a Location Package
waypoint	Waypoint (one-of type)	Present when sending a Waypoint Package

Channel

Name	Description
Satellite	Sends Package over satellite
Radio	Sends Package over radio (Node only)
Cellular	Sends Package over cellular networks or WiFi

Data

Field	Type	Description
payload	String (Base64 Encoded)	Raw bytes to send

Message

Field	Type	Description
content	String	Message content

Location

Field	Type	Description
latitude	Double	Latitude of coordinate (WGS84)
longitude	Double	Longitude of coordinate (WGS84)
timestamp	String (ISO 8601)	Timestamp of coordinate (optional)
altitude	Float	Altitude above mean sea level (optional)
speedOverGround	Float	Speed relative to the earth surface in m/s (optional)
courseOverGround	Float	Degrees clockwise from true north (optional)

Waypoint

Field	Type	Description
latitude	Double	Latitude of coordinate (WGS84)
longitude	Double	Longitude of coordinate (WGS84)
timestamp	String (ISO 8601)	Timestamp of coordinate (optional)
name	String	Name of the point of interest
notes	String	Additional notes about the point of interest (optional)

Response

Your response will include a status. When using this endpoint, your status cases are terminal statuses which are listed below.

200

{
  "id": 1,
  "status": "Delivered",
  "data": {
    "payload": ""
  }
}

400

429

Package Status

Name	Description
Delivered	Package was sent over the channel successfully. This doesn't necessarily mean that the Package reached its final destination. For example, when sent over satellite this means the Package successfully reached the satellite gateway, but not when the target client actually receives it.
Error	Package failed to send over any channel.
Collapsed	Package was collapsed, or replaced by a more recent Package.
Canceled	Package was canceled by calling /api/package/{id}/cancel