Integration dashboard not displaying third-party data widgets after API connection

IoT Cisco IoT Cloud Connect
, , , , , , ,
1

After successfully connecting our third-party weather monitoring system via REST API, the expected data widgets aren’t appearing on the IoT Operations Dashboard. The API integration shows as ‘Connected’ with green status in the integration panel, and I can verify data is flowing through by checking the API logs.

However, when I navigate to the dashboard where these widgets should appear, I only see placeholder boxes with ‘Widget Configuration Error’ messages. I’ve verified the API integration mapping is correct and returns valid JSON responses. The dashboard permissions appear to be set correctly for my admin role. Is there a specific widget manifest configuration required for third-party integrations in cciot-25, or could this be a permissions issue at a different level?

2

Also check the API integration permissions in cciot-25. Even with admin role on the dashboard, third-party integrations have separate permission scopes. Your integration needs ‘dashboard:widget:create’ and ‘dashboard:data:read’ scopes granted explicitly. These aren’t included in the default admin role for security reasons.

3

The ‘Widget Configuration Error’ usually means the widget definition isn’t properly registered with the dashboard framework. Did you deploy the widget manifest file? Third-party integrations require explicit widget registration even if the API connection is working.

4

I didn’t know about a separate widget manifest file. I assumed connecting the API would automatically create the widgets. Where should this manifest be deployed and what format does it need?

5

One more thing - verify your API response structure matches what the dashboard expects. Even with correct manifest and permissions, if your API returns data in an unexpected format, widgets will fail to render. The integration mapping should include field transformations if your API structure differs from the standard IoT Operations schema.

6

Here’s the complete solution addressing all three focus areas:

API Integration Mapping: Your API connection is working, but the data mapping needs refinement. Navigate to Integrations > API Connections > [Your Weather API] > Field Mapping. Ensure you’ve mapped the API response fields to IoT Operations Dashboard standard fields. For example:

  • API field ‘temp_celsius’ → Dashboard field ‘temperature’
  • API field ‘humidity_pct’ → Dashboard field ‘humidity’
  • API field ‘timestamp_utc’ → Dashboard field ‘observedAt’

The mapping configuration should include data type transformations if needed (string to number, date format conversions, etc.). Test the mapping using the ‘Preview Data’ button to verify the transformed output matches dashboard expectations.

Widget Manifest Configuration: You need to create and deploy a widget manifest. Here’s the structure:

  1. Create a JSON file named ‘weather-widgets-manifest.json’

  2. Define each widget type you want to display:

    • Widget ID and display name
    • Data source (your API integration ID)
    • Visualization type (chart, gauge, table, map)
    • Refresh interval
    • Required data fields

  3. Upload via Dashboard Configuration > Integrations > Widget Definitions > Import Manifest

The manifest tells the dashboard framework how to instantiate widgets using your API data. Without it, the dashboard has no template for rendering your third-party data.

Dashboard Permissions: This is likely your main issue. Third-party integrations in cciot-25 require explicit permission grants beyond standard role assignments. Fix this:

  1. Go to Administration > Integration Permissions

  2. Find your weather API integration

  3. Add these scopes:

    • ‘dashboard:widget:create’ - allows widgets to be instantiated
    • ‘dashboard:data:read’ - allows widgets to fetch data
    • ‘dashboard:render’ - allows visualization rendering

  4. Assign these permissions to the user groups that need access to the weather widgets

The ‘Widget Configuration Error’ specifically indicates missing ‘dashboard:widget:create’ permission. Even though your admin role can see the dashboard, the integration itself lacks permission to create widget instances.

After granting permissions, you may need to refresh the API connection (disconnect and reconnect) for the new scopes to take effect. Then reload your dashboard - the placeholder boxes should be replaced with actual weather data widgets.

If widgets still don’t appear, check the browser console for specific error messages. Common issues include CORS configuration for the API endpoint or SSL certificate validation failures for third-party APIs.

7

The widget manifest is a JSON file that defines how dashboard widgets interact with your API integration. It needs to be uploaded through the Dashboard Configuration panel under Integrations > Widget Definitions. The manifest specifies data mappings, refresh intervals, visualization types, and required permissions. Without it, the dashboard doesn’t know how to render your API data.