---
canonical_url: "https://docs.composio.dev/toolkits/visualping"
markdown_url: "https://docs.composio.dev/toolkits/visualping.md"
product: "platform"
version: null
last_updated: null
---

# Visualping

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

- **Category:** productivity
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `VISUALPING`
- **Version:** 00000000_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("VISUAL" | "WEB" | "TEXT" | "ALL") | No | Shared change-detection mode. |
| `interval` | string | Yes | Shared check interval in minutes as a string, such as '1440'. |
| `monitors` | array | Yes | Two or more monitors to create with the shared mode and interval. |
| `workspace_id` | integer | Yes | Target workspace ID from Describe Account. Bulk import must be enabled for the workspace. |
| `initialize_without_baseline` | boolean | No | Whether to create monitors without using an initial screenshot as their comparison baseline. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Monitor

**Slug:** `VISUALPING_CREATE_MONITOR`

Create a monitor in a workspace. Visualping immediately performs an initial check, which uses monitoring capacity or credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Absolute web page URL to monitor. |
| `crop` | object | No | Optional rectangular visual region to monitor. |
| `mode` | string ("VISUAL" | "WEB" | "TEXT" | "ALL") | No | Change-detection mode. |
| `active` | boolean | No | Whether recurring checks start enabled. |
| `interval` | string | Yes | Check interval in minutes as a string, such as '1440'. |
| `keywords` | string | No | Keyword expression used by keyword-based detection. |
| `selector` | string | No | XPath or CSS selector restricting the monitored page region. |
| `description` | string | No | Human-readable monitor name or purpose. |
| `notification` | object | No | Optional email, SMS, and provider-specific notification settings. |
| `workspace_id` | integer | Yes | Target workspace ID from Describe Account; required for reliable Business-account creation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Monitor

**Slug:** `VISUALPING_DELETE_MONITOR`

Permanently delete one monitor from its Visualping workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | integer | Yes | Monitor to permanently delete. |
| `workspace_id` | integer | Yes | Owning workspace ID from Describe Account; required for reliable Business-account deletion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Monitor

**Slug:** `VISUALPING_GET_MONITOR`

Get a monitor's configuration, check history, and detected changes in one response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | integer | Yes | Numeric monitor ID from Create Monitor or List Monitors. Integer-like strings are accepted. |
| `workspace_id` | integer | No | Workspace ID. It may be omitted for the selected workspace-scoped key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_ids` | array | Yes | One or more monitor IDs to check now. |
| `workspace_id` | integer | Yes | Workspace owning all requested monitors. |
| `restart_schedule` | boolean | No | Whether launching resets each monitor's recurring schedule from now; false preserves its cadence. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Monitors

**Slug:** `VISUALPING_LIST_MONITORS`

List and filter monitors visible to the connected workspace, returning one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event` | string ("changed" | "changedImportant" | "errored" | "checked") | No | Filter by the latest relevant event type. |
| `active` | boolean | No | Filter to active or inactive monitors. |
| `search` | string | No | Case-insensitive full-text search over monitor details. |
| `sort_by` | array | No | Ordered sort criteria, sent comma-separated; for example active_first then lastrun_desc. |
| `page_size` | integer | No | 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") | No | Filter monitor events to a predefined date range. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit to start at the first page and pass returned cursors back unchanged. |
| `workspace_id` | integer | No | Workspace to list. May be omitted for a workspace-scoped key, which infers its workspace. |
| `date_range_start` | string | No | ISO date required when date_range is since_custom_date. |
| `monitoring_modes` | array | No | Monitoring modes to include; sent as a comma-separated filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_ids` | array | Yes | One or more active monitor IDs whose check-credit requirements should be estimated. |
| `workspace_id` | integer | Yes | Workspace owning all requested monitors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Replacement absolute page URL. |
| `crop` | object | No | Replacement visual region to monitor. |
| `mode` | string ("VISUAL" | "WEB" | "TEXT" | "ALL") | No | Replacement change-detection mode. |
| `active` | boolean | No | Whether to enable or pause recurring checks. |
| `job_id` | integer | Yes | Numeric ID of the monitor to update. Integer-like strings are accepted. |
| `interval` | string | No | Replacement check interval in minutes as a string. |
| `keywords` | string | No | Replacement keyword expression. |
| `selector` | string | No | Replacement XPath or CSS selector. |
| `description` | string | No | Replacement monitor name or purpose. |
| `notification` | object | No | Replacement notification settings. |
| `workspace_id` | integer | Yes | Owning workspace ID from Describe Account; required for reliable Business-account writes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |