Back to Autogpt

Exa Websets Monitor

docs/integrations/block-integrations/exa/websets_monitor.md

0.6.448.4 KB
Original Source

Exa Websets Monitor

<!-- MANUAL: file_description -->

Blocks for creating scheduled monitors to automatically update Exa websets.

<!-- END MANUAL -->

Exa Create Monitor

What it is

Create automated monitors to keep websets updated with fresh data on a schedule

How it works

<!-- MANUAL: how_it_works -->

This block creates a scheduled monitor that automatically updates a webset on a cron schedule. Monitors can either search for new items matching criteria or refresh existing item content and enrichments.

Configure the cron expression for your desired frequency (daily, weekly, etc.) and choose between search behavior to find new items or refresh behavior to update existing data.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the Webset to monitorstrYes
cron_expressionCron expression for scheduling (5 fields, max once per day)strYes
timezoneIANA timezone for the schedulestrNo
behavior_typeType of monitor behavior (search for new items or refresh existing)"search" | "refresh"No
search_querySearch query for finding new items (required for search behavior)strNo
search_countNumber of items to find in each searchintNo
search_criteriaCriteria that items must meetList[str]No
search_behaviorHow new results interact with existing items"append" | "override"No
entity_typeType of entity to search for (company, person, etc.)strNo
refresh_contentRefresh content from source URLs (for refresh behavior)boolNo
refresh_enrichmentsRe-run enrichments on items (for refresh behavior)boolNo
metadataMetadata to attach to the monitorDict[str, Any]No

Outputs

OutputDescriptionType
errorError message if the operation failedstr
monitor_idThe unique identifier for the created monitorstr
webset_idThe webset this monitor belongs tostr
statusStatus of the monitorstr
behavior_typeType of monitor behaviorstr
next_run_atWhen the monitor will next runstr
cron_expressionThe schedule cron expressionstr
timezoneThe timezone for schedulingstr
created_atWhen the monitor was createdstr

Possible use case

<!-- MANUAL: use_case -->

Continuous Lead Generation: Schedule daily searches to find new companies matching your criteria.

News Monitoring: Set up monitors to discover fresh articles on topics of interest.

Data Freshness: Schedule periodic refreshes to keep enrichment data current.

<!-- END MANUAL -->

Exa Delete Monitor

What it is

Delete a monitor from a webset

How it works

<!-- MANUAL: how_it_works -->

This block permanently deletes a monitor, stopping all future scheduled runs. Any data already collected by the monitor remains in the webset.

Use this to clean up monitors that are no longer needed or to stop scheduled operations before deleting a webset.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
monitor_idThe ID of the monitor to deletestrYes

Outputs

OutputDescriptionType
errorError message if the operation failedstr
monitor_idThe ID of the deleted monitorstr
successWhether the deletion was successfulstr

Possible use case

<!-- MANUAL: use_case -->

Project Completion: Delete monitors when monitoring campaigns or projects conclude.

Cost Management: Remove monitors that are no longer providing value to reduce costs.

Configuration Cleanup: Delete old monitors before creating updated replacements.

<!-- END MANUAL -->

Exa Get Monitor

What it is

Get the details and status of a webset monitor

How it works

<!-- MANUAL: how_it_works -->

This block retrieves detailed information about a monitor including its configuration, schedule, current status, and information about the last run.

Use this to verify monitor settings, check when the next run is scheduled, or review results from recent executions.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
monitor_idThe ID of the monitor to retrievestrYes

Outputs

OutputDescriptionType
errorError message if the operation failedstr
monitor_idThe unique identifier for the monitorstr
webset_idThe webset this monitor belongs tostr
statusCurrent status of the monitorstr
behavior_typeType of monitor behaviorstr
behavior_configConfiguration for the monitor behaviorDict[str, Any]
cron_expressionThe schedule cron expressionstr
timezoneThe timezone for schedulingstr
next_run_atWhen the monitor will next runstr
last_runInformation about the last runDict[str, Any]
created_atWhen the monitor was createdstr
updated_atWhen the monitor was last updatedstr
metadataMetadata attached to the monitorDict[str, Any]

Possible use case

<!-- MANUAL: use_case -->

Schedule Verification: Check when monitors are scheduled to run next.

Performance Review: Examine last run details to assess monitor effectiveness.

Configuration Audit: Retrieve monitor settings for documentation or troubleshooting.

<!-- END MANUAL -->

Exa List Monitors

What it is

List all monitors with optional webset filtering

How it works

<!-- MANUAL: how_it_works -->

This block retrieves a paginated list of all monitors, optionally filtered by webset. Results include basic monitor information such as status, schedule, and next run time.

Use this to get an overview of all active monitors or find monitors associated with a specific webset.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idFilter monitors by webset IDstrNo
limitNumber of monitors to returnintNo
cursorCursor for paginationstrNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
monitorsList of monitorsList[Dict[str, Any]]
monitorIndividual monitor (yielded for each monitor)Dict[str, Any]
has_moreWhether there are more monitors to paginate throughbool
next_cursorCursor for the next page of resultsstr

Possible use case

<!-- MANUAL: use_case -->

Monitor Dashboard: Build dashboards showing all active monitors and their schedules.

Webset Management: Find monitors associated with websets before making changes.

Activity Overview: Review all scheduled monitoring activity across your account.

<!-- END MANUAL -->

Exa Update Monitor

What it is

Update a monitor's status, schedule, or metadata

How it works

<!-- MANUAL: how_it_works -->

This block modifies an existing monitor's configuration. You can enable, disable, or pause monitors, change their schedule, update the timezone, or modify metadata.

Changes take effect immediately. Disabling a monitor stops future scheduled runs until re-enabled.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
monitor_idThe ID of the monitor to updatestrYes
statusNew status for the monitor"enabled" | "disabled" | "paused"No
cron_expressionNew cron expression for schedulingstrNo
timezoneNew timezone for the schedulestrNo
metadataNew metadata for the monitorDict[str, Any]No

Outputs

OutputDescriptionType
errorError message if the operation failedstr
monitor_idThe unique identifier for the monitorstr
statusUpdated status of the monitorstr
next_run_atWhen the monitor will next runstr
updated_atWhen the monitor was updatedstr
successWhether the update was successfulstr

Possible use case

<!-- MANUAL: use_case -->

Schedule Changes: Adjust monitor frequency based on data velocity or business needs.

Pause/Resume: Temporarily pause monitors during maintenance or when not needed.

Status Management: Enable or disable monitors programmatically based on conditions.

<!-- END MANUAL -->