Forward AWS IoT Hook

POST 
/integrations/aws-iot

Forward AWS IoT Hook

Request

Path Parameters

organizationId string

Query Parameters

event stringrequired

Possible values: [up]

The event to forward.

application/json

Body

required

timestamp numberrequired

The ID used for deduplication.

organizationId stringrequired

The time of the payload in ISO 8601 format.

assetId stringrequired

Information about the IoT device.

event stringrequired

The ID of the tenant.

data objectrequired

The name of the tenant.

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...