curl --request POST \
  --url https://api.crustdata.com/watch/{dataset}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "track": {
    "field": "experience.employment_details.current",
    "type": "added"
  },
  "fields": [
    "basic_profile",
    "experience"
  ],
  "deliver": false
}
'

{
  "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"
          }
        }
      ]
    }
  }
}

Preview an entity notification

Builds a sample notification from a track and fields you have not saved yet, so a create form can show or deliver the exact envelope before the watch exists.

The sample record is generated by walking the dataset’s own enrich model, so every trackable field is present in the exact production shape and the sample never drifts from the schema. Its values are a fixed, public demo profile rather than a real subject of yours. It is signed exactly as a real delivery is, so a receiver that verifies here verifies production, and metadata.watch_id is 0 because no watch exists yet.

Same guarantees as the saved-watch test: no run, no snapshot, no credit, nothing persisted.

POST

https://api.crustdata.com

/

watch

/

{dataset}

/

test

curl --request POST \
  --url https://api.crustdata.com/watch/{dataset}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "track": {
    "field": "experience.employment_details.current",
    "type": "added"
  },
  "fields": [
    "basic_profile",
    "experience"
  ],
  "deliver": false
}
'

{
  "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. Entity watches support person and company; there is no job entity watch, and job returns 404 here. Use /watch/job/search for jobs.

Available options:

person,

company

Example:

"person"

Body

application/json

An in-progress entity watch config to build a sample from. Carries the same track and fields a create request would, but nothing is saved.

track

object

The track tree to build the sample changes array from.

Option 1
Option 2

Show child attributes

fields

string[]

Field groups to project the sample record to. Entitlement-checked like a create.

Example:

["basic_profile", "experience"]

notification_endpoint

string<uri>

Public URL to deliver the sample to. Required when deliver is not false, since there is no saved watch to fall back on.

Example:

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

count

integer

default:1

Required range: 1 <= x <= 25

Example:

1

deliver

boolean

default:true

Set false to get the envelope back without sending anything.

Example:

false

Response

The sample was built, and delivered when deliver was not false.

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

Update an entity watch Create an entity watch Get an entity watch Company Entity Watcher Person Entity Watcher

⌘I