The Cognipoint webhook will POST space updates to the IBSS endpoint, which will then process the received data and store it in the IBSS data store.
Communication to the endpoint is via HTTPS/TLS1.2 and will require a customer specific API key to be provided as a header parameter.
Description |
Details |
|---|---|
Communication Method |
Notification Based |
IBSS Endpoint |
|
Payload |
JSON |
Service Calls |
POST (Webhook) |
Security |
HTTPS / TLS1.2
x-functions-key (header)
|
Spaces |
areaId
devices
count
type
timestamp
|
Availability |
IBSS Cloud Only |
Setting up Cognipoint
To connect Cognipoint sensors to the IBSS platform a couple of steps are required to get the interface up and running. This article describes these steps at a high level.
1. Configuring CPMS
The following steps are required in CPMS prior to setting up the interface.
- Configure the areas of interest in CPMS.
- Export from the API the mapping of space to areaId and provide to ICONICS to setup against spaces portfolio.
2. Connecting Cognipoint to IBSS
As the interface from Cognipoint to IBSS is via webhook (change driven), the following information needs to be sent to Cognipoint for Pointgrab to setup the webhook.
Item |
Description |
|---|---|
x-functions-key |
Authentication header that CPMS will send with each update. |
endpoint |
The URL that CPMS will send the updates to. |
3. Creating the Telemetry Subscription
Once confirmation is received from Pointgrab that the webhook is setup, the final part of the configuration is to create the subscription. This is done via the API using the POST /cp/v3/telemetry/subscriptions call which has the following properties.
The client can either do this themselves, or credentials for API access will need to be provided to ICONICS to perform.
Property |
Description |
|---|---|
authorizationHeaderKey |
the x-functions-header key sent to Pointgrab |
endpoint |
The URL to which the subscription will send the updates to. |
notificationType |
currently supported:
- COUNTING
|
subscriptionType |
PUSH |