curl --request POST \
  --url https://api.crustdata.com/watch/{dataset}/search/{watch_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '{}'

{
  "delivered": [
    {
      "type": "webhook",
      "endpoint": "https://your-server.example.com/webhook",
      "http_status": 200,
      "ok": true,
      "response": "{\"received\": true}"
    }
  ],
  "envelope": {
    "metadata": {
      "watch_id": 46936,
      "kind": "entity",
      "dataset": "person",
      "api_version": "2025-11-01",
      "run_id": 64200,
      "notification_id": "ntf_64200",
      "delivered_at": "2026-07-16T03:20:00.351849+00:00",
      "test": true,
      "summary": {
        "delivered": 1,
        "total_count": 1,
        "max_results_per_run": 100,
        "truncated": false
      }
    },
    "results": {
      "added": [
        {
          "job_details": {
            "title": "Backend Engineer, Vehicle Software",
            "url": "https://www.example-jobs.com/postings/4448814407",
            "category": "Engineering",
            "workplace_type": "On-site",
            "number_of_openings": 1
          },
          "company": {
            "basic_info": {
              "name": "Tesla",
              "primary_domain": "tesla.com"
            }
          },
          "location": {
            "raw": "Palo Alto, California, United States",
            "country": "United States"
          },
          "metadata": {
            "date_added": "2026-08-04T05:32:47"
          }
        }
      ]
    }
  }
}

Test a discovery watch

Delivers a sample notification so you can verify a receiver end to end before waiting for a real run.

The sample is built from real current matches of the watch’s own filter, ignoring the watermark and the already-seen set, and shaped through the same processor a real run uses, so the payload is identical to production apart from metadata.test: true. Nothing is recorded: no run, no seen-set advance, no credit, no persistence.

Every body field is optional. Send deliver: false to get the envelope back without any outbound request. If the watch’s filter currently matches nothing there is nothing to sample, and the call returns 400 with the envelope still attached.

POST

https://api.crustdata.com

/

watch

/

{dataset}

/

search

/

{watch_id}

/

test

curl --request POST \
  --url https://api.crustdata.com/watch/{dataset}/search/{watch_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '{}'

{
  "delivered": [
    {
      "type": "webhook",
      "endpoint": "https://your-server.example.com/webhook",
      "http_status": 200,
      "ok": true,
      "response": "{\"received\": true}"
    }
  ],
  "envelope": {
    "metadata": {
      "watch_id": 46936,
      "kind": "entity",
      "dataset": "person",
      "api_version": "2025-11-01",
      "run_id": 64200,
      "notification_id": "ntf_64200",
      "delivered_at": "2026-07-16T03:20:00.351849+00:00",
      "test": true,
      "summary": {
        "delivered": 1,
        "total_count": 1,
        "max_results_per_run": 100,
        "truncated": false
      }
    },
    "results": {
      "added": [
        {
          "job_details": {
            "title": "Backend Engineer, Vehicle Software",
            "url": "https://www.example-jobs.com/postings/4448814407",
            "category": "Engineering",
            "workplace_type": "On-site",
            "number_of_openings": 1
          },
          "company": {
            "basic_info": {
              "name": "Tesla",
              "primary_domain": "tesla.com"
            }
          },
          "location": {
            "raw": "Palo Alto, California, United States",
            "country": "United States"
          },
          "metadata": {
            "date_added": "2026-08-04T05:32:47"
          }
        }
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version

enum<string>

default:2025-11-01

required

API version to use. 2025-11-01 is the only accepted value. Send it on every call: it is enforced today on POST /watch/{dataset}/search, where a missing or unrecognized value returns 400, and the other watch routes accept a request without it rather than relying on that.

Available options:

2025-11-01

Example:

"2025-11-01"

Path Parameters

dataset

enum<string>

required

The dataset the watch is built on.

Available options:

person,

company,

job

Example:

"person"

watch_id

integer

required

The watch's id, returned when it was created.

Example:

46936

Body

application/json

Options for a discovery watch's test send. Every field is optional, so an empty object is a valid body.

notification_endpoint

string<uri>

Deliver this one test to a URL you control instead of the watch's configured channels, which pairs well with a request-inspection service. Must be a public http(s) URL: endpoints resolving to private, loopback, or link-local addresses are rejected.

Example:

"https://your-server.example.com/webhook"

count

integer

default:1

How many real current matches to include in the one envelope, so you can exercise multi-record handling.

Required range: 1 <= x <= 25

Example:

3

deliver

boolean

default:true

Set false to build and return the envelope without sending anything.

Example:

true

Response

A delivery was attempted. Read delivered[].http_status for each channel's outcome.

The result of a test send, carrying what each channel answered and the exact envelope that was delivered.

delivered

object[]

One entry per channel the test was sent to. Empty when deliver was false.

Show child attributes

envelope

object

The body POSTed to each webhook channel, and the same body a test send returns under envelope.

The two watch kinds shape results differently. A discovery watch keys results by membership polarity, so records arrive under results.added, each one the raw dataset record. An entity watch delivers a flat list, one object per fired subject, each with its own changes and record.

Show child attributes

Related topics

Test an entity watch Get a discovery watch Update a discovery watch List discovery watches Cancel a discovery watch

⌘I