Export IoT data to Webhook

Article
12/06/2023

This article describes how to configure data export to send data to the Webhook.

Use this feature to continuously export filtered and enriched IoT data from your IoT Central application. Data export pushes changes in near real time to other parts of your cloud solution for warm-path insights, analytics, and storage.

For example, you can:

Continuously export telemetry, property changes, device connectivity, device lifecycle, device template lifecycle, and audit log data in JSON format in near real time.
Filter the data streams to export data that matches custom conditions.
Enrich the data streams with custom values and property values from the device.
Transform the data streams to modify their shape and content.

Tip

When you turn on data export, you get only the data from that moment onward. To retain more historical data, turn on data export early. To manually export data from times when data export was turned off, see How to use the IoT Central REST API to query devices.

Note

In some circumstances it could take up to 60 seconds for the messages to be exported. This time is measured from when IoT Central receives the message from the underlying IoT hub to when the message is delivered to the destination endpoint.

Prerequisites

To use data export features, you must have the Data export permission.

Set up a Webhook export destination

For Webhook destinations, IoT Central exports data in near real time. The data in the message body is in the same format as for Event Hubs and Service Bus.

Create a Webhook destination

You can export data to a publicly available HTTP Webhook endpoint. You can create a test Webhook endpoint using RequestBin. RequestBin throttles request when the request limit is reached:

Navigate to RequestBin.
Select Create a RequestBin.
Sign in with one of the available methods.
Copy the URL of your RequestBin You use this URL when you test your data export.

To create the Azure Data Explorer destination in IoT Central on the Data export page:

Select + New destination.
Select Webhook as the destination type.
Paste the callback URL for your Webhook endpoint. You can optionally configure Webhook authorization and add custom headers.
- For OAuth2.0, only the client credentials grant flow is supported. When you save the destination, IoT Central communicates with your OAuth provider to retrieve an authorization token. This token is attached to the Authorization header for every message sent to this destination.
- For Authorization token, you can specify a token value that's directly attached to the Authorization header for every message sent to this destination.
Select Save.

Example OAuth 2.0 configuration

This example shows how to configure a Webhook destination to use an Azure Function App that's protected by using Microsoft Entra sign-in:

Setting	Example	Notes
Destination type	Webhook
Callback URL	`https://myapp.azurewebsites.net/api/HttpExample`	The function URL.
Authorization	OAuth 2.0
Token URL	`https://login.microsoftonline.com/your-tenant-id/oauth2/v2.0/token`	The URL to use to retrieve a token. You can find this value in your Function App: Authentication > Your Microsoft Identity provider > Endpoints > OAuth 2.0 token endpoint (v2)
Client ID	`your-client-id`	The client ID of your Function App. You can find this value in your Function App: Authentication > Your Microsoft Identity provider > Application (client) ID
Client secret	`your-client-secret`	The client secret of your Function App. You can find this value in your Function App: Authentication > Your Microsoft Identity provider > Certificates & secrets
Audience	N/A	Blank if you're using a Function App.
Scope	`https://your-client-id/.default`	The scope of the token. For a Function App, use the client ID value.**
Token request content type	Auto

Other webhook destinations might require different values for these settings.

Set up a data export

Now that you have a destination to export your data to, set up data export in your IoT Central application:

Sign in to your IoT Central application.
In the left pane, select Data export.

Tip

If you don't see Data export in the left pane, then you don't have permissions to configure data export in your app. Talk to an administrator to set up data export.
Select + New export.
Enter a display name for your new export, and make sure the data export is Enabled.

Choose the type of data to export. The following table lists the supported data export types:

Data type	Description	Data format
Telemetry	Export telemetry messages from devices in near-real time. Each exported message contains the full contents of the original device message, normalized.	Telemetry message format
Property changes	Export changes to device and cloud properties in near-real time. For read-only device properties, changes to the reported values are exported. For read-write properties, both reported and desired values are exported.	Property change message format
Device connectivity	Export device connected and disconnected events.	Device connectivity message format
Device lifecycle	Export device registered, deleted, provisioned, enabled, disabled, displayNameChanged, and deviceTemplateChanged events.	Device lifecycle changes message format
Device template lifecycle	Export published device template changes including created, updated, and deleted.	Device template lifecycle changes message format
Audit logs	Logs of user-initiated updates to entities in the application. To learn more, see Use audit logs to track activity in your IoT Central application	Audit log message format

Optionally, add filters to reduce the amount of data exported. There are different types of filter available for each data export type:

Type of data	Available filters
Telemetry	Filter by device name, device ID, device template, and if the device is simulated Filter stream to only contain telemetry that meets the filter conditions Filter stream to only contain telemetry from devices with properties matching the filter conditions Filter stream to only contain telemetry that has message properties meeting the filter condition. Message properties (also known as application properties) are sent in a bag of key-value pairs on each telemetry message. To create a message property filter, enter the message property key you're looking for, and specify a condition. Only telemetry messages with properties that match the specified filter condition are exported. Learn more about application properties from IoT Hub docs
Property changes	Filter by device name, device ID, device template, and if the device is simulated Filter stream to only contain property changes that meet the filter conditions
Device connectivity	Filter by device name, device ID, device template, organizations, and if the device is simulated Filter stream to only contain changes from devices with properties matching the filter conditions
Device lifecycle	Filter by device name, device ID, device template, and if the device is provisioned, enabled, or simulated Filter stream to only contain changes from devices with properties matching the filter conditions
Device template lifecycle	Filter by device template
Audit logs	N/A

Optionally, enrich exported messages with extra key-value pair metadata. The following enrichments are available for the telemetry, property changes, device connectivity, and device lifecycle data export types:
- Custom string: Adds a custom static string to each message. Enter any key, and enter any string value.
- Property, which adds to each message:
  - Device metadata such as device name, device template name, enabled, organizations, provisioned, and simulated.
  - The current device reported property or cloud property value to each message. If the exported message is from a device that doesn't have the specified property, the exported message doesn't get the enrichment.

Configure the export destination:

Select + Destination to add a destination that you've already created or select Create a new one.
To transform your data before it's exported, select + Transform. To learn more, see Transform data inside your IoT Central application for export.
Select + Destination to add up to five destinations to a single export.
When you've finished setting up your export, select Save. After a few minutes, your data appears in your destinations.

Monitor your export

In IoT Central, the Data export page lets you check the status of your exports. You can also use Azure Monitor to see how much data you're exporting and any export errors. You can access export and device health metrics in charts in the Azure portal by using, the REST API, queries in PowerShell, or the Azure CLI. Currently, you can monitor the following data export metrics in Azure Monitor:

Number of messages incoming to export before filters are applied.
Number of messages that pass through filters.
Number of messages successfully exported to destinations.
Number of errors found.

To learn more, see Monitor application health.

Data formats

The following sections describe the formats of the exported data:

Telemetry format

Each exported message contains a normalized form of the full message the device sent in the message body. The message is in JSON format and encoded as UTF-8. Information in each message includes:

applicationId: The ID of the IoT Central application.
messageSource: The source for the message - telemetry.
deviceId: The ID of the device that sent the telemetry message.
schema: The name and version of the payload schema.
templateId: The ID of the device template assigned to the device.
enqueuedTime: The time at which IoT Central received this message.
enrichments: Any enrichments set up on the export.
module: The IoT Edge module that sent this message. This field only appears if the message came from an IoT Edge module.
component: The component that sent this message. This field only appears if the capabilities sent in the message were modeled as a component in the device template
messageProperties: Other properties that the device sent with the message. These properties are sometimes referred to as application properties. Learn more from IoT Hub docs.

Message properties

Telemetry messages have properties for metadata as well as the telemetry payload. The previous snippet shows examples of system messages such as deviceId and enqueuedTime. To learn more about the system message properties, see System Properties of D2C IoT Hub messages.

You can add properties to telemetry messages if you need to add custom metadata to your telemetry messages. For example, you need to add a timestamp when the device creates the message.

The following code snippet shows how to add the iothub-creation-time-utc property to the message when you create it on the device:

Important

The format of this timestamp must be UTC with no timezone information. For example, 2021-04-21T11:30:16Z is valid, 2021-04-21T11:30:16-07:00 is invalid.

async function sendTelemetry(deviceClient, index) {
  console.log('Sending telemetry message %d...', index);
  const msg = new Message(
    JSON.stringify(
      deviceTemperatureSensor.updateSensor().getCurrentTemperatureObject()
    )
  );
  msg.properties.add("iothub-creation-time-utc", new Date().toISOString());
  msg.contentType = 'application/json';
  msg.contentEncoding = 'utf-8';
  await deviceClient.sendEvent(msg);
}

private static void sendTemperatureTelemetry() {
  String telemetryName = "temperature";
  String telemetryPayload = String.format("{\"%s\": %f}", telemetryName, temperature);

  Message message = new Message(telemetryPayload);
  message.setContentEncoding(StandardCharsets.UTF_8.name());
  message.setContentTypeFinal("application/json");
  message.setProperty("iothub-creation-time-utc", Instant.now().toString());

  deviceClient.sendEventAsync(message, new MessageIotHubEventCallback(), message);
  log.debug("My Telemetry: Sent - {\"{}\": {}°C} with message Id {}.", telemetryName, temperature, message.getMessageId());
  temperatureReadings.put(new Date(), temperature);
}

private async Task SendTemperatureTelemetryAsync()
{
  const string telemetryName = "temperature";

  string telemetryPayload = $"{{ \"{telemetryName}\": {_temperature} }}";
  using var message = new Message(Encoding.UTF8.GetBytes(telemetryPayload))
  {
      ContentEncoding = "utf-8",
      ContentType = "application/json",
  };
  message.Properties.Add("iothub-creation-time-utc", DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ"));
  await _deviceClient.SendEventAsync(message);
  _logger.LogDebug($"Telemetry: Sent - {{ \"{telemetryName}\": {_temperature}°C }}.");
}

async def send_telemetry_from_thermostat(device_client, telemetry_msg):
    msg = Message(json.dumps(telemetry_msg))
    msg.custom_properties["iothub-creation-time-utc"] = datetime.now(timezone.utc).isoformat()
    msg.content_encoding = "utf-8"
    msg.content_type = "application/json"
    print("Sent message")
    await device_client.send_message(msg)

Property changes format

Each message or record represents changes to device and cloud properties. Information in the exported message includes:

applicationId: The ID of the IoT Central application.
messageSource: The source for the message - properties.
messageType: Either cloudPropertyChange, devicePropertyDesiredChange, or devicePropertyReportedChange.
deviceId: The ID of the device that sent the telemetry message.
schema: The name and version of the payload schema.
enqueuedTime: The time at which IoT Central detected this change.
templateId: The ID of the device template assigned to the device.
properties: An array of properties that changed, including the names of the properties and values that changed. The component and module information is included if the property is modeled within a component or an IoT Edge module.
enrichments: Any enrichments set up on the export.

Device connectivity changes format

Each message or record represents a connectivity event from a single device. Information in the exported message includes:

applicationId: The ID of the IoT Central application.
messageSource: The source for the message - deviceConnectivity.
messageType: Either connected or disconnected.
deviceId: The ID of the device that was changed.
schema: The name and version of the payload schema.
templateId: The ID of the device template assigned to the device.
enqueuedTime: The time at which this change occurred in IoT Central.
enrichments: Any enrichments set up on the export.

Device lifecycle changes format

Each message or record represents one change to a single device. Information in the exported message includes:

applicationId: The ID of the IoT Central application.
messageSource: The source for the message - deviceLifecycle.
messageType: The type of change that occurred. One of: registered, deleted, provisioned, enabled, disabled, displayNameChanged, and deviceTemplateChanged.
deviceId: The ID of the device that was changed.
schema: The name and version of the payload schema.
templateId: The ID of the device template assigned to the device.
enqueuedTime: The time at which this change occurred in IoT Central.
enrichments: Any enrichments set up on the export.

Device template lifecycle changes format

Each message or record represents one change to a single published device template. Information in the exported message includes:

applicationId: The ID of the IoT Central application.
messageSource: The source for the message - deviceTemplateLifecycle.
messageType: Either created, updated, or deleted.
schema: The name and version of the payload schema.
templateId: The ID of the device template assigned to the device.
enqueuedTime: The time at which this change occurred in IoT Central.
enrichments: Any enrichments set up on the export.

Audit log format

Each audit log message represents a user-initiated change to an auditable entity inside the IoT Central application. Information in the exported message includes:

actor: Information about the user who modified the entity.
applicationId: The ID of the IoT Central application.
messageSource: The source for the message - audit.
messageType: The type of change that occurred. One of: updated, created, deleted.
updated: Only present if messageType is updated. Provides more detail about the update.
resource: Details of the modified entity.
schema: The name and version of the payload schema.
deviceId: The ID of the device that was changed.
enqueuedTime: The time at which this change occurred in IoT Central.
enrichments: Any enrichments set up on the export.

Next steps

Now that you know how to export to Service Bus, a suggested next step is to learn Export to Event Hubs.