Create data delivery rule

post

https://api.sensos.io/v1/accounts/{accountId}/data-delivery-rules

Create and immediately activate a new automated data delivery export rule. Once configured, Sensos will continuously stream incoming label telemetry and shipment events matching the rule filters to your designated destination:

Webhook: Dispatches signed HTTP POST requests with JSON payloads to your HTTPS endpoint.

Returns the created rule configuration with its assigned configurationId.

Path Params

accountId

string

required

Unique identifier of the Sensos account.

Body Params

Configuration parameters for the new data delivery export rule, including destination credentials and event filters.

Request parameters for creating or updating a data delivery export rule.

name

string

required

Descriptive name for the data delivery export rule.

description

string

Optional human-readable description of the export rule's purpose.

status

string

enum

Operational status of the data delivery rule.

Allowed:

scope

object

Defines the scope of devices covered by this export configuration. If omitted or empty, all devices under the account are included.

dataSourceType

string

enum

Type of telemetry stream to export (real-time periodic sensor reports or continuous temperature logging bursts).

Allowed:

templateId

string

Identifier of the payload format template.

skipNoLocationReports

boolean

When true, suppresses export of telemetry events that do not include valid location fixes.

action

object

required

HTTP Webhook delivery action configuration.

Response

201Data delivery export rule created and activated successfully.