Skip to content

AyeWatch API Quickstart: Create a Monitor and a Webhook in curl

Monitor a web page with the AyeWatch REST API: get a key, create a monitor with a plain-English rule, list, pause and delete it, and receive signed webhook updates. All in curl.

By AyeWatch Team5 min read

Short answer: To monitor a website with the AyeWatch API, create a key in API access settings, then send POST https://ayewatch.ai/api/v1/topics with a Bearer header and the page URL as name. Add PUT /api/v1/webhook to receive each update. API access needs a paid plan, and the default limit is 120 requests per minute.

Get a key and make a first call

Create a key in API access settings. Keys look like aw_live_ followed by 96 hex characters, and an account can hold up to 10 active ones. API keys are only available on paid plans, and a key reaches your monitors and your webhook secret, so keep it on a server and use one key per integration. Send it as a Bearer token. This call lists your monitors:

curl https://ayewatch.ai/api/v1/topics \
  -H "Authorization: Bearer aw_live_YOUR_API_KEY"

A missing or invalid key returns 401 with {"error": {"message": "Unauthorized", "status": 401}}. Every response carries RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset and X-Request-Id headers.

Create a monitor with a plain-English rule

A name that is a URL creates a web page monitor. The description field holds the rule in plain English, and interval sets how often AyeWatch checks. Your plan must allow the interval you pick, or the call returns 400.

Sample rule: Alert me when Northgate Dental changes the price of a cleaning, whitening or filling. Ignore opening hours.

curl -X POST https://ayewatch.ai/api/v1/topics \
  -H "Authorization: Bearer aw_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "https://northgatedental.example/pricing",
    "description": "Alert me when the price of a cleaning, whitening or filling changes. Ignore opening hours.",
    "interval": "1_hour"
  }'

The 201 response holds only id, name, description, interval, is_active and created_at. Keep the id. Saved changes apply at once, and monitoring may take a few minutes to start. A name that is plain text creates a subject monitor instead, and a source object creates a platform monitor.

List, pause and delete

List with filters, pause with is_active and remove with DELETE. The id comes from the create response or the list.

curl "https://ayewatch.ai/api/v1/topics?page=1&page_size=10&is_active=true" \
  -H "Authorization: Bearer aw_live_YOUR_API_KEY"

curl -X PUT https://ayewatch.ai/api/v1/topics/1042 \
  -H "Authorization: Bearer aw_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"is_active": false}'

curl -X DELETE https://ayewatch.ai/api/v1/topics/1042 \
  -H "Authorization: Bearer aw_live_YOUR_API_KEY"

A PUT needs at least one field, and unknown fields are rejected with a 400. DELETE is permanent and removes the schedule. These endpoints cover every monitor in your account, including ones made in the app.

Receive updates by webhook

One call sets the endpoint. The URL must be public HTTPS, and private, loopback and internal addresses are rejected.

curl -X PUT https://ayewatch.ai/api/v1/webhook \
  -H "Authorization: Bearer aw_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"webhook_url": "https://example.com/hooks/ayewatch"}'

The response includes the secret that signs every delivery. AyeWatch then sends a POST only when a monitor detects new content. A made-up delivery for the sample rule:

{
  "topic_id": 1042,
  "topic_name": "https://northgatedental.example/pricing",
  "update_id": 55318,
  "headline": "Northgate Dental raises whitening to $299",
  "content": "The pricing page lists teeth whitening at $299, up from $249. Cleaning and fillings are unchanged.",
  "created_at": "2026-11-27T17:12:00Z"
}

Check the X-AyeWatch-Signature header against the raw body before you act on it, as shown in the signature guide. Respond with a 2xx within 10 seconds. Failed deliveries are retried with exponential backoff for up to 10 attempts, so use update_id to skip repeats.

Errors and what to do about them

Every error uses the same shape, an error object with a message and a status that mirrors the HTTP code. Check the HTTP status first, then read the message. The table below lists each code the docs define.

When the API is the wrong tool

  • You need past alerts. The API manages monitors and the webhook. It has no endpoint that returns alert history, so store each delivery as it arrives.
  • You want an assistant to do it. The MCP server offers the same actions as tools.
  • A one-off check. Open the page. A monitor earns its place when you would otherwise check repeatedly.
  • Pages behind a login. AyeWatch reads public pages and cannot sign in.

Cost and effort

AyeWatch Pro is $9/mo with 50 topics and hourly checks; Pro+ is $19/mo with 200 topics and ASAP mode. Every plan starts with a 7-day free trial. API calls have no separate bill. Active monitors use credits as checks run, and turning a monitor on needs enough credits for one check. Accounts also have a default storage limit of 3,000 topics, counting active and paused ones. Plan on an hour to build the first working version, most of it spent on the webhook receiver.

From key to first update

  1. Create an API key in API access settings and store it in an environment variable or secrets manager.
  2. Run the list call above to confirm the key works. An empty data array is a good result.
  3. Create the monitor with a URL as name, a plain-English description and an interval your plan allows.
  4. Deploy a receiver that checks X-AyeWatch-Signature and returns a 2xx, then set its URL with PUT /api/v1/webhook.
  5. Wait for the next real update. The webhook has no test endpoint, so the first delivery is a real alert.
  6. Pause or delete the monitor with PUT or DELETE when you are done.
StatusMeaning in the AyeWatch APIWhat to do
400Invalid or missing fields, or an interval your plan does not allowFix the body or pick an allowed interval
401API key missing, malformed or unknownCheck the Authorization header and the key
403No active plan, a plan limit reached, or no monitoring credits leftCheck your plan and credits
404Topic not found, or no webhook configured yetCheck the id, or create the webhook first
409A topic with that name exists, or another change was still being appliedRename it, or retry the second case after a short pause
429Rate limit exceeded for this keyWait for the seconds in the Retry-After header
500An error on AyeWatch's sideRetry, or contact support with the request ID

Start a monitor in under a minute

Describe a topic or paste a URL. Cancel before the trial ends and you pay nothing.

Try it free for 7 days

The bottom line

Run the list call with a fresh key today, then create one monitor for a page you check by hand. Point the webhook at a receiver that logs deliveries before you add anything clever.

FAQ

What is the base URL of the AyeWatch API?

https://ayewatch.ai/api/v1. Every request needs an Authorization header with a Bearer API key.

Which plans can use the API?

Paid plans. AyeWatch Pro is $9/mo and Pro+ is $19/mo, and every plan starts with a 7-day free trial.

What is the API rate limit?

120 requests per minute per API key by default. A 429 response includes a Retry-After header.

Can I create a monitor without an interval?

Only with monitoring_mode set to auto. For custom monitoring, interval is required, for example 1_hour, and your plan must allow it.

How do I verify a webhook came from AyeWatch?

Compute an HMAC-SHA256 of the raw request body with your webhook secret and compare it with the X-AyeWatch-Signature header, which has the form sha256= followed by the hex digest.

ayewatch api quickstartwebsite monitoring apicreate a website monitor with curlmonitoring api webhook example

Related articles