Configuring a Data Connector
Data Connectors can be configured for different use-cases.
Last updated
Was this helpful?
Data Connectors can be configured for different use-cases.
Last updated
Was this helpful?
Before diving into how to configure a Data Connector, there are a few things worth keeping in mind when working with them.
Multiple Projects Data Connectors are created and configured on a per-project basis. If you want multiple projects to send data to the same Endpoint URL, you have to create one Data Connector per project.
Multiple Data Connectors All Data Connectors in a project will receive events from all the devices in that project. It is recommended to filter on event types when possible.
Access Control To create, update, or delete a Data Connector, your DT Studio User or must have the of Project Developer or higher.
A Data Connector can be enabled or disabled at any time. A Data Connector that is disabled will not forward events to its Endpoint URL until it is re-enabled. Any events that were generated while the Data Connector was disabled will not be forwarded once the Data Connector is re-enabled.
In , click on API Integrations -> Data Connectors. Select the desired Data Connector, then toggle the Data Connector enabled switch. Remember to click Update Data Connector.
Disabled Data Connectors have no at-least-once guarantee.
When a Data Connector is disabled, undelivered events and events generated after being disabled will not be sent. Re-enabling the Data Connector will not backfill data from the period it was disabled and must be fetched programmatically using our REST API.
A Data Connector will be automatically disabled by DT Cloud if it has failed consistently for an extended period of time (currently 5 days) without any success. A push-attempt from a Data Connector is considered a failure if the receiver responded with a non-200 status code, or didn’t respond at all. A Data Connector that is disabled by DT Cloud will get the status SYSTEM_DISABLED
.
DT Studio uses labels with the keys name
and description
as the display name and the description of a device. It is recommended that an integration uses these labels in the same way when displaying or updating a device.
Custom HTTP headers can be included with each event forwarded by a Data Connector.
The JWT payload contains the checksum of the request body.
Adding a signature secret to your Data Connector will automatically sign each forwarded event.
When synchronizing a Data Connector, the most recent event of each event type of each device currently in the project will be published to the Data Connector. This can be useful when a new Data Connector has been set up, and you need to get an up-to-date snapshot of each device in the project.
Once the package is installed and authenticated as described in the , a Data Connector can be updated by calling the following resource method.
The status
field of a Data Connector can be set to either "ACTIVE"
or "USER_DISABLED"
. If the Data Connector gets automatically disabled by DT Cloud, the status will be set to SYSTEM_DISABLED
. See the section for more information.
By default, all are forwarded by a Data Connector. If you want to avoid unnecessary traffic on your endpoint, events can be filtered by type.
In , click on API Integrations -> Data Connectors. Select the desired Data Connector, then toggle the Forward All Events followed by a selection. Remember to click Update Data Connector.
The events array takes one- or several .
Once the package is installed and authenticated as described in the , a Data Connector can be updated by calling the following resource method.
A Data Connector can optionally forward device labels along with each event. By default, no device labels will be included, but you can specify a list of label keys that should be included in each request. See the section for more details about how these device labels are included in the requests.
In , click on API Integrations -> Data Connectors. Select the desired Data Connector, then append the label keys to the list. Remember to click Update Data Connector.
Once the package is installed and authenticated as described in the , a Data Connector can be updated by calling the following resource method.
In , click on API Integrations -> Data Connectors. Select the desired Data Connector, then add a key- and value pairs for your custom headers. Remember to click Update Data Connector.
Once the package is installed and authenticated as described in the , a Data Connector can be updated by calling the following resource method.
For increased security in a production integration, we recommend configuring a Signature Secret which can be used to on the receiving end.
The HTTP header of the webhook request includes a that is signed with the Signature Secret.
This allows you to validate the origin and the content integrity of the received request for a more secure integration. The process is two-fold and must be configured for both the Data Connector and the receiving .
In , click on API Integrations -> Data Connectors. Select the desired Data Connector, then add a strong and unique signature secret. Remember to click Update Data Connector.
Once the package is installed and authenticated as described in the , a Data Connector can be updated by calling the following resource method.
To handle incoming events that have been signed by a signature secret, see .
In , click on API Integrations -> Data Connectors. Select the desired Data Connector, then click Synchronize Data Connector towards the bottom of the page.
Once the package is installed and authenticated as described in the , a Data Connector can be synced by calling the following resource method.