Create Sensor

POST

api

sys

sensors

Create Sensor

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/sensors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Reference": "<string>",
  "SensorType": 123,
  "DataStrategy": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/sensors"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Reference": "<string>",
    "SensorType": 123,
    "DataStrategy": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    Reference: '<string>',
    SensorType: 123,
    DataStrategy: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/sensors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A sensor is an IoT device for a location that receives or polls environmental and occupancy readings, and can use changed readings to update availability, manage bookings, and send alerts.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Sensor-Create role.

Enums

eSensorType — SensorType values

Value	Name
1	PresenceDetection
2	PeopleCounter
3	Temperature
4	Humidity
5	Light
6	Noise
7	CO2
8	VolatileOrganicCompounds
9	HarmfulParticulates
10	Touch
11	Water
12	AtmosphericPressure
13	Power
14	OpenClosed
99	Other

eSensorDataStrategy — DataStrategy values

Value	Name
1	Polling
2	Endpoint
3	DisruptiveTechnologies
4	Pressac

Request Body

Required Fields

integer

required

ID of the required location that owns this sensor..

string

required

Required non-empty display name for the sensor; together with Unit it identifies the sensor within the location..

string

required

Required unique integration reference used to find this sensor within its location; set it when creating the sensor and do not change it later..

integer

required

Kind of reading produced by the device: PresenceDetection, PeopleCounter, Temperature, Humidity, Light, Noise, CO2, VolatileOrganicCompounds, HarmfulParticulates, Touch, Water, AtmosphericPressure, Power, OpenClosed, or Other; presence values are normalized to 0 or 1..

integer

required

How readings reach Nexudus: Polling fetches data from PayloadDataPath, while Endpoint, DisruptiveTechnologies, and Pressac receive data through their integrations..

Optional Fields

integer[]

List of floor plan desks whose occupancy and latest sensor value this sensor can update; an empty list means no desks are affected..

integer[]

List of bookable resources whose availability, occupancy, and latest sensor value this sensor can update; an empty list means no resources are affected..

integer

ID of the optional email template used by sensor alert actions..

string

Optional unit label for the sensor reading, such as C, percent, or people; together with Name it identifies the sensor within the location..

boolean

Whether the sensor accepts incoming data and can be polled; inactive sensors do neither..

string

URL fetched for a Polling sensor to obtain its payload; polling does nothing when this value is empty..

string

Optional Flee expression that decides whether a changed reading runs enabled actions; leave empty to run actions for every changed reading, and use payload and sensor as the available context variables..

string

Optional Flee expression that extracts the sensor reading from the incoming payload; leave empty to use payload[“value”]..

boolean

Whether a changed reading that triggers actions sends an operator email alert; repeated alerts are suppressed until a non-triggering reading occurs..

string

Optional email address that receives operator sensor alerts when ActionSendEmailAlert is enabled; must be a valid email address..

string

Optional destination URL used by the HTTP request action; it is also logged as the polling source for diagnostics..

boolean

Whether triggering readings update availability for the linked floor plan desks..

boolean

Whether triggering readings update availability for the linked bookable resources..

boolean

Whether triggering readings update occupancy for current bookings on linked resources..

boolean

Whether a changed reading that triggers actions sends a customer alert email; repeated alerts are suppressed until a non-triggering reading occurs..

boolean

Whether triggering readings automatically start pending bookings on linked resources..

boolean

Whether triggering readings automatically terminate active bookings on linked resources..

boolean

Whether triggering readings automatically check customers in or out..

boolean

Whether triggering readings send an HTTP request to WebhookUrl..

boolean

Whether the sensor is shown in the Now dashboard for live monitoring..

boolean

Whether this active sensor is included in customer portal and app sensor data..

string

Encrypted shared secret used to validate incoming webhook signatures; configure it through a secure integration workflow, not the Admin Agent..

string

Encrypted API credential used to authenticate sensor polling or incoming requests; configure it through a secure integration workflow, not the Admin Agent..

string

Username paired with the encrypted Password for HTTP Basic authentication; it is not usable through the Admin Agent because the paired password is protected..

string

Encrypted password paired with Username for HTTP Basic authentication; configure it through a secure integration workflow, not the Admin Agent..

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/sensors" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Reference": "",
    "SensorType": 0,
    "DataStrategy": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/sensors',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Reference: '',
      SensorType: 0,
      DataStrategy: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/sensors',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Reference': '',
        'SensorType': 0,
        'DataStrategy': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the sensor was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Sensor was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Create Sensor

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/sensors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Reference": "<string>",
  "SensorType": 123,
  "DataStrategy": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/sensors"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Reference": "<string>",
    "SensorType": 123,
    "DataStrategy": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    Reference: '<string>',
    SensorType: 123,
    DataStrategy: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/sensors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400