Skip to main content
POST
/
catchAll
/
monitors
/
create
Create monitor
curl --request POST \
  --url https://catchall.newscatcherapi.com/catchAll/monitors/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reference_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "schedule": "every day at 12 PM UTC",
  "webhook": {
    "url": "<string>",
    "method": "POST",
    "headers": {},
    "params": {},
    "auth": [
      "<string>"
    ]
  }
}
'
{
  "status": "Monitor Created Successfully",
  "monitor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication.

Body

application/json
​
reference_job_id
string<uuid>
required

Job ID to use as template for scheduled runs.

Job's end_date must be within the last 7 days.

​
schedule
string
required

Natural language schedule (e.g. 'every day at 12 AM EST').

Minimum frequency: Monitors must be scheduled at least 24 hours apart.

Example:

"every day at 12 PM UTC"

​
webhook
object

Optional webhook to receive notifications when jobs complete.

Response

Monitor created successfully

​
status
string
required

Creation status or error message

Example:

"Monitor Created Successfully"

​
monitor_id
string<uuid>

Monitor ID if successful, null if error.