API and Auth Basics

Automation Watchdog is designed to be simple to integrate.

What a workflow needs

• the API endpoint
• an organization-scoped API token
• the target watch id
• optional queue, machine, or outcome values depending on the monitoring design

Typical API actions

Most integrations use some combination of:

• activate a watch
• check in to a watch
• deactivate a watch

Authentication model

API access is controlled with organization-scoped tokens. Teams often create separate tokens for each environment, such as development, test, and production.

Environment guidance

Use environment-specific tokens and environment flags to keep monitoring behavior aligned to where the workflow is running. That helps teams test safely without sending production-style notifications unintentionally.

API details

For endpoint definitions, request formats, and authentication specifics, use the Swagger or API documentation available from your Automation Watchdog instance.

See also:

• Configure Automation Environment
• Create API Token