Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,13 @@ If the event monitor's reference job used connected entity datasets, connected e

- [Enable Monitor](https://www.newscatcherapi.com/docs/web-search-api/api-reference/event-monitors/enable-monitor): Resume scheduled job execution for an event monitor.
- [Disable Monitor](https://www.newscatcherapi.com/docs/web-search-api/api-reference/event-monitors/disable-monitor): Stop scheduled job execution for an event monitor.
- [Update Monitor](https://www.newscatcherapi.com/docs/web-search-api/api-reference/event-monitors/update-monitor): Update the webhook configuration for an existing event monitor.
- [Update Monitor](https://www.newscatcherapi.com/docs/web-search-api/api-reference/event-monitors/update-monitor): Update the webhook assignments, record limit, or schedule of an existing
event monitor. Omitted fields are left unchanged.

Passing `schedule` replaces the event monitor's current schedule. The new
schedule takes effect from the next scheduler reload, and the old schedule
stops firing. The reference job cannot be changed.

- [Delete Monitor](https://www.newscatcherapi.com/docs/web-search-api/api-reference/event-monitors/delete-monitor): Soft-deletes an event monitor. The event monitor is flagged as deleted, stops
executing scheduled jobs immediately, and no longer appears in list
results.
Expand Down
50 changes: 44 additions & 6 deletions web-search-api/api-reference/catch-all-api.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.1.0
info:
title: NewsCatcher CatchAll API
version: 1.8.1
version: 1.8.2
description: |
CatchAll is a web search API that generates unique datasets that don't exist anywhere else on the web. Built on NewsCatcher's proprietary real-world event index, it delivers state-of-the-art recall—finding all relevant events, not just top results.

Expand Down Expand Up @@ -675,7 +675,13 @@ paths:
tags:
- Event Monitors
summary: Update event monitor
description: Update the webhook configuration for an existing event monitor.
description: |
Update the webhook assignments, record limit, or schedule of an existing
event monitor. Omitted fields are left unchanged.

Passing `schedule` replaces the event monitor's current schedule. The new
schedule takes effect from the next scheduler reload, and the old schedule
stops firing. The reference job cannot be changed.
operationId: updateMonitor
externalDocs:
description: Learn about event monitor configuration
Expand All @@ -694,9 +700,17 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/UpdateMonitorRequestDto"
example:
webhook_ids:
- "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
examples:
update_webhooks:
summary: Update webhook assignments
value:
webhook_ids:
- "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
update_schedule:
summary: Change the schedule
value:
schedule: "every Monday at 9 AM"
timezone: "America/New_York"
responses:
"200":
$ref: "#/components/responses/UpdateMonitorResponse"
Expand All @@ -707,7 +721,13 @@ paths:
"404":
$ref: "#/components/responses/NotFoundError"
"422":
$ref: "#/components/responses/ValidationError"
description: |
Validation error. Also returned when `schedule` can't be parsed into a
cron expression, or when runs would be spaced too closely.
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationErrorResponse"

delete:
tags:
Expand Down Expand Up @@ -5020,6 +5040,24 @@ components:
type: integer
minimum: 10
description: Updated maximum number of records per event monitor run.
schedule:
type: [string, "null"]
description: |
New natural-language schedule that replaces the event monitor's current
schedule. Examples: `every day at 9 AM`, `every Monday at 6 PM EST`.

Omit to keep the current schedule. The new schedule takes effect from the
next scheduler reload, and the old schedule stops firing. Returns `422` if
the text can't be parsed or runs would be spaced too closely.
example: "every day at 9 AM"
timezone:
type: [string, "null"]
default: UTC
description: |
IANA timezone for the new schedule (for example, `America/New_York`).
A timezone included in the `schedule` text takes precedence. Ignored if
`schedule` is not set.
example: "America/New_York"

UpdateMonitorResponseDto:
type: object
Expand Down
Loading
Loading