Skip to main content
This guide strings together the full pipeline: test a query, create a webhook, schedule a monitor, and handle the results your endpoint receives. Each step links to its detailed reference if you need to go deeper.

​
Before you begin

  • Get a CatchAll API key from platform.newscatcherapi.com.
  • Set up a publicly accessible HTTPS endpoint that returns a 2xx and accepts a JSON POST, or use webhook.site for testing.
  • Optionally, install the CatchAll SDK for your language:
# cURL is included on most systems. Check with:
curl --version
1

Test the query

Submit your query as a one-off job and review the results before committing it to a schedule. Keep the job_id; you reference it when creating the monitor.
curl -X POST "https://catchall.newscatcherapi.com/catchAll/submit" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Acquisitions, mergers, and funding rounds in the fintech industry",
    "limit": 10
  }'
Each record is structured according to an LLM-generated enrichment schema. A single record looks like this:
{
  "record_id": "5685210581375815445",
  "record_title": "Marvell to Acquire Celestial AI for $3.25 Billion",
  "enrichment": {
    "enrichment_confidence": "high",
    "deal_date": "2025-12-02",
    "acquiring_company": "Marvell Technology",
    "acquired_company": "Celestial AI",
    "deal_value": "$3.25 billion"
  },
  "citations": [
    { "title": "Marvell to buy chip startup Celestial AI for $3.25 billion", "link": "https://example.com/marvell-celestial", "published_date": "2025-12-04 03:01:56" }
  ]
}
Field names inside enrichment are LLM-generated and vary between jobs, even for the same query. To lock the schema, define custom enrichments on the job or preview suggestions with POST /catchAll/initialize. See Dynamic schemas.
2

Create a webhook

A webhook is created once at the organization level, then attached to any number of jobs or monitors. Save the returned webhook.id.
curl -X POST "https://catchall.newscatcherapi.com/catchAll/webhooks" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Fintech deals feed",
    "url": "https://your-app.com/catchall/webhook",
    "type": "generic",
    "delivery_mode": "full"
  }'
Verify your endpoint is reachable before going live with POST /catchAll/webhooks/{webhook_id}/test. CatchAll also supports slack and teams webhook types. See Set up webhooks.
3

Schedule a monitor

A monitor re-runs your query on a schedule, deduplicates against previous runs, and delivers each run to the webhooks in webhook_ids.
curl -X POST "https://catchall.newscatcherapi.com/catchAll/monitors/create" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reference_job_id": "YOUR_JOB_ID",
    "schedule": "every day at 9 AM UTC",
    "webhook_ids": ["YOUR_WEBHOOK_ID"]
  }'
The reference job’s end_date must be within the last 7 days, and the default minimum schedule interval is 24 hours, but can be more frequent depending on your subscription plan. See Configure monitors.
4

Handle the delivery

After each scheduled run, CatchAll sends a POST to your webhook URL. Return a 2xx within 5 seconds and process asynchronously.The payload:
{
  "monitor_id": "3fec5b07-8786-46d7-9486-d43ff67eccd4",
  "latest_job_id": "295b95d8-6041-4f4b-b132-9f009fc6af70",
  "records_count": 2,
  "records": [
    {
      "record_id": "5685210581375815445",
      "record_title": "Brightwell Financial acquires SMB lender Keystone Capital for $740M",
      "enrichment": {
        "enrichment_confidence": "high",
        "event_type": "acquisition",
        "acquiring_company": "Brightwell Financial",
        "acquired_company": "Keystone Capital",
        "deal_value": "$740 million"
      },
      "citations": [
        { "title": "Brightwell to buy Keystone Capital", "link": "https://example.com/brightwell-keystone", "published_date": "2026-06-17 09:01:00" }
      ]
    }
  ]
}
A minimal receiver reads the structured fields directly:
from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route("/catchall/webhook", methods=["POST"])
def handle_webhook():
    payload = request.json
    # Return 200 immediately, then process asynchronously
    if payload["records_count"] > 0:
        for r in payload["records"]:
            e = r.get("enrichment", {})
            print(e.get("acquiring_company"), e.get("deal_value"), "-", r["record_title"])
    return jsonify({"status": "received"}), 200
Prefer no code? Point the webhook url at an n8n, Make, or Zapier webhook trigger and map records into a Slack message, a spreadsheet row, or a CRM record.

​
Adapt it

Swap the query for any event you want to watch: product recalls, executive moves, regulatory actions, competitor launches. The pipeline is identical: test the query, create a webhook, schedule a monitor, handle the delivery. To change which webhooks a monitor notifies, PATCH /catchAll/monitors/{monitor_id} with new webhook_ids.

​
See also