Appearance
Add Check-in to Workflow
A check-in is the API call your workflow makes to Automation Watchdog to signal that it is running. This page covers how to integrate check-ins into your workflow.
Check-in Parameters
Each check-in API call accepts the following parameters:
| Parameter | Required | Description |
|---|---|---|
| machine | No | Identifies which machine is checking in. Required when using Condition By Machine. |
| queue | No | Identifies which queue is being processed. Required when using Condition By Queue. |
| outcome | No | Reports the result of the workflow step: 1 for success, 2 for failure. Used by Threshold Monitoring. |
When to Check In
Choose a check-in pattern that matches your workflow's behavior:
Per item: Check in after processing each work item. Best for item-level monitoring and threshold tracking. Each check-in can include an outcome to report whether the item was processed successfully.
Per batch: Check in after completing a batch of items. Useful when individual item processing is fast and per-item check-ins would be excessive.
Periodic: Check in at regular intervals regardless of work processed. Suitable for long-running processes that do not process discrete items.
Reporting Outcomes
When Threshold Monitoring is enabled on your watch, include the outcome parameter in your check-ins to report whether each step succeeded or failed.
- Send
outcome: 1(success) when the workflow step completes without error - Send
outcome: 2(failure) when the workflow step encounters an error
The watch evaluates outcomes against the configured threshold to detect quality degradation. If no outcome is provided, the check-in still satisfies the watch's timing requirements but is not counted toward threshold evaluation.
Activate On Check-In
When Activate On Check-In is enabled on a non-scheduled watch, the first check-in to an inactive watch will automatically activate it. This means your workflow does not need to make a separate activation API call before it begins checking in.
This is available for Standard, Condition By Queue, and Condition By Machine watches.
This is particularly useful for Condition By Machine watches, where machines can self-register and activate the watch simply by checking in. Queue and machine parameters are still required when the selected watch mode needs them.
UiPath Integration
We recommend using the freely available 'Automation Watchdog Library' for handling API Requests to Automation Watchdog.
Download the Library.
Edit the Library.
2.1. Modify the private workflow GetAssets.xaml and update the values in the Initialize Local Variables sequence to match the assets you created during the Configure Automation Environment step.
2.2. Publish the Library.
Add the package to your workflow.
The library contains activities:
- AWD Checkin : Performs a check-in for the provided Watch Id
- AWD Activate : Activates the provided Watch Id
- AWD Deactviate : Deactivates the provided Watch Id
Other Platforms
For workflows running on platforms other than UiPath, use the Automation Watchdog REST API directly. Any platform capable of making HTTP requests can integrate with Automation Watchdog.
Refer to the Swagger API documentation available from your Automation Watchdog instance for endpoint details, request formats, and authentication requirements.