> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Visualping

> Visualping monitors web pages for visual, text, and content changes and sends alerts when detected changes match configured criteria.

![Visualping logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/visualping.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=27ac560ee04dbdf07baa35263f8946c7)

* **Category:** productivity
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 9
* **Triggers:** 0
* **Slug:** `VISUALPING`
* **Version:** 20261101\_00

## Tools

> [accordion] Bulk Create Monitors
>
> **Slug:** `VISUALPING_BULK_CREATE_MONITORS`
>
> Create two or more active monitors with shared detection settings. Each monitor starts checking immediately and may consume monitoring credits; use only when workspace bulk import is enabled.
>
> #### Input Parameters
>
> **mode** `string ("VISUAL" | "WEB" | "TEXT" | "ALL")`
>
> Shared change-detection mode.
>
> **interval** `string` *required*
>
> Shared check interval in minutes as a string, such as '1440'.
>
> **monitors** `array` *required*
>
> Two or more monitors to create with the shared mode and interval.
>
> **workspace\_id** `integer` *required*
>
> Target workspace ID from Describe Account. Bulk import must be enabled for the workspace.
>
> **initialize\_without\_baseline** `boolean`
>
> Whether to create monitors without using an initial screenshot as their comparison baseline.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Monitor
>
> **Slug:** `VISUALPING_CREATE_MONITOR`
>
> Create a monitor in a workspace; an initial check may use monitoring capacity or credits. When creating a paused monitor, the tool attempts to pause and verify it, and may delete the new monitor if pausing fails.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Absolute web page URL to monitor.
>
> **crop** `object`
>
> Optional rectangular visual region to monitor.
>
> **mode** `string ("VISUAL" | "WEB" | "TEXT" | "ALL")`
>
> Change-detection mode.
>
> **active** `boolean`
>
> Whether recurring checks start enabled.
>
> **interval** `string` *required*
>
> Check interval in minutes as a string, such as '1440'.
>
> **keywords** `string`
>
> Keyword expression used by keyword-based detection.
>
> **selector** `string`
>
> XPath or CSS selector restricting the monitored page region.
>
> **description** `string`
>
> Human-readable monitor name or purpose.
>
> **notification** `object`
>
> Optional email, SMS, and provider-specific notification settings.
>
> **workspace\_id** `integer` *required*
>
> Target workspace ID from Describe Account; required for reliable Business-account creation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Monitor
>
> **Slug:** `VISUALPING_DELETE_MONITOR`
>
> Permanently delete one monitor from its Visualping workspace.
>
> #### Input Parameters
>
> **job\_id** `integer` *required*
>
> Monitor to permanently delete.
>
> **workspace\_id** `integer` *required*
>
> Owning workspace ID from Describe Account; required for reliable Business-account deletion.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Describe Account and Workspaces
>
> **Slug:** `VISUALPING_DESCRIBE_ACCOUNT`
>
> Return the connected Visualping account, organization, workspaces, plan limits, balances, and monitor counts. Use this first to resolve a workspace ID for write operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Monitor
>
> **Slug:** `VISUALPING_GET_MONITOR`
>
> Get a monitor's configuration, check history, and detected changes in one response.
>
> #### Input Parameters
>
> **job\_id** `integer` *required*
>
> Numeric monitor ID from Create Monitor or List Monitors. Integer-like strings are accepted.
>
> **workspace\_id** `integer`
>
> Workspace ID. It may be omitted for the selected workspace-scoped key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Launch Monitor Checks
>
> **Slug:** `VISUALPING_LAUNCH_MONITOR_CHECKS`
>
> Immediately launch checks for one or more active monitors, consuming or reserving monitoring credits. Use Preflight Monitor Checks first to confirm credit requirements.
>
> #### Input Parameters
>
> **job\_ids** `array` *required*
>
> One or more monitor IDs to check now.
>
> **workspace\_id** `integer` *required*
>
> Workspace owning all requested monitors.
>
> **restart\_schedule** `boolean`
>
> Whether launching resets each monitor's recurring schedule from now; false preserves its cadence.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Monitors
>
> **Slug:** `VISUALPING_LIST_MONITORS`
>
> List and filter monitors visible to the connected workspace, returning one page and a continuation cursor.
>
> #### Input Parameters
>
> **event** `string ("changed" | "changedImportant" | "errored" | "checked")`
>
> Filter by the latest relevant event type.
>
> **active** `boolean`
>
> Filter to active or inactive monitors.
>
> **search** `string`
>
> Case-insensitive full-text search over monitor details.
>
> **sort\_by** `array`
>
> Ordered sort criteria, sent comma-separated; for example active\_first then lastrun\_desc.
>
> **page\_size** `integer`
>
> Number of monitors to request per page; must be at least 1.
>
> **date\_range** `string ("since_last_login" | "since_yesterday" | "since_last_week" | "since_last_month" | "since_custom_date")`
>
> Filter monitor events to a predefined date range.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit to start at the first page and pass returned cursors back unchanged.
>
> **workspace\_id** `integer`
>
> Workspace to list. May be omitted for a workspace-scoped key, which infers its workspace.
>
> **date\_range\_start** `string`
>
> ISO date required when date\_range is since\_custom\_date.
>
> **monitoring\_modes** `array`
>
> Monitoring modes to include; sent as a comma-separated filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Preflight Monitor Checks
>
> **Slug:** `VISUALPING_PREFLIGHT_MONITOR_CHECKS`
>
> Estimate the credits required to check one or more active monitors without launching a check or changing their schedules.
>
> #### Input Parameters
>
> **job\_ids** `array` *required*
>
> One or more active monitor IDs whose check-credit requirements should be estimated.
>
> **workspace\_id** `integer` *required*
>
> Workspace owning all requested monitors.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Monitor
>
> **Slug:** `VISUALPING_UPDATE_MONITOR`
>
> Partially update a monitor's core URL, schedule, detection, state, or notification settings. Only explicitly supplied mutable fields are sent. The response reports impact and estimated consumption rather than the updated monitor representation.
>
> #### Input Parameters
>
> **url** `string`
>
> Replacement absolute page URL.
>
> **crop** `object`
>
> Replacement visual region to monitor.
>
> **mode** `string ("VISUAL" | "WEB" | "TEXT" | "ALL")`
>
> Replacement change-detection mode.
>
> **active** `boolean`
>
> Whether to enable or pause recurring checks.
>
> **job\_id** `integer` *required*
>
> Numeric ID of the monitor to update. Integer-like strings are accepted.
>
> **interval** `string`
>
> Replacement check interval in minutes as a string.
>
> **keywords** `string`
>
> Replacement keyword expression.
>
> **selector** `string`
>
> Replacement XPath or CSS selector.
>
> **description** `string`
>
> Replacement monitor name or purpose.
>
> **notification** `object`
>
> Replacement notification settings.
>
> **workspace\_id** `integer` *required*
>
> Owning workspace ID from Describe Account; required for reliable Business-account writes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
