Skip to content
Rokks Docs

Web API Stream to Alert

Web API Stream to Alert

Section titled “Web API Stream to Alert”

Goal

Section titled “Goal”

Create a web data stream, sync it into Rokks, and add an alert that watches the resulting data.

Steps

Section titled “Steps”
  1. Open Web Data and create a connection.
  2. Add a stream for one endpoint.
  3. Test a sample response.
  4. Review the generated transform plan.
  5. Configure a sync schedule.
  6. Wait for Dispatcher to submit the first scheduled sync, then confirm in the Job Queue that it finishes successfully.
  7. Build a small dashboard widget from the stream.
  8. Open Sentinel Alerts.
  9. Create a rule that uses a field from the synced source.
  10. Test the rule and notification path.

Manual Web API Sync and Full Sync actions are currently unavailable in the UI and Sidekick. This tutorial therefore uses the first Dispatcher-scheduled run as the end-to-end validation.

Common mistakes

Section titled “Common mistakes”

Do not build the widget or alert before the first scheduled sync has completed and its output has been validated.

Do not create an alert rule against a field whose type or unit is still unclear.

If the alert does not trigger, check the stream job first. A rule can be correct while the source data is stale, empty, or loaded into a different tenant than the one you are testing.

Section titled “Related”