Forward ChirpstackV4 Hook

POST 
/integrations/chirpstack-v4

Forward ChirpstackV4 Hook

Request

Path Parameters

organizationId string

Query Parameters

event stringrequired

Possible values: [up]

The event to forward.

application/json

Body

required

deduplicationId stringrequired

The ID used for deduplication.

time stringrequired

The time of the payload in ISO 8601 format.

deviceInfo objectrequired
Information about the IoT device.
tenantId stringrequired
tenantName stringrequired
applicationId stringrequired
applicationName stringrequired
deviceProfileId stringrequired
deviceProfileName stringrequired
deviceName stringrequired
devEui stringrequired
deviceClassEnabled stringrequired
tags objectrequired
devAddr stringrequired

The device address.

adr booleanrequired

Flag indicating if Adaptive Data Rate (ADR) is enabled.

dr numberrequired

The data rate used by the device.

fCnt numberrequired

The frame counter.

fPort numberrequired

The FPort number.

confirmed booleanrequired

Flag indicating if the transmission was confirmed.

data stringrequired

The payload data.

rxInfo required

Information about the received packet.

rxInfo[] stringrequired

.crcStatus The status of the CRC check.

txInfo objectrequired
Information about the transmitted packet.
frequency numberrequired
modulation objectrequired
lora objectrequired
bandwidth numberrequired
spreadingFactor numberrequired
codeRate stringrequired

Responses

200

application/json

Schema

Schema

forwarded booleanrequired

forwarded successfully.

Example (from schema)

{
  "forwarded": true
}

Example

{
  "forwarded": true
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

Loading...