curl --request POST \
  --url https://api.crustdata.com/watch/{dataset}/{watch_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "notification_endpoint": "https://your-server.example.com/webhook",
  "fields": [
    "basic_profile",
    "experience"
  ]
}
'

{
  "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 an entity watch

Pushes one sample notification through a saved entity watch so you can verify a receiver end to end: signature check, JSON parsing, routing, without waiting for a subject to actually move.

The envelope is exactly what a real run sends, flagged with metadata.test: true. The record is built from the dataset’s own enrich model and filled with a fixed, public demo profile, so your parser sees production structure without real subject data. The signature is computed the same way as a real delivery, HMAC-SHA256 over <timestamp>.<raw-body> keyed by your API key, sent as x-crustdata-signature: t=<unix>,v1=<hex>.

It runs no diff, records no snapshot, costs no credits, and persists nothing. All body fields are optional.

POST

https://api.crustdata.com

/

watch

/

{dataset}

/

{watch_id}

/

test

curl --request POST \
  --url https://api.crustdata.com/watch/{dataset}/{watch_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "notification_endpoint": "https://your-server.example.com/webhook",
  "fields": [
    "basic_profile",
    "experience"
  ]
}
'

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

watch_id

integer

required

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

Example:

46936

Body

application/json

Options for an entity watch's test send. Every field is optional.

notification_endpoint

string<uri>

Deliver this one test to a public URL you control instead of the watch's configured channels.

Example:

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

fields

string[]

Project the sample record to a chosen field set for this test. Defaults to the watch's own fields, and is entitlement-checked like a create.

Example:

["basic_profile", "experience"]

count

integer

default:1

Deliver this many sample subjects in one envelope. Each gets a distinct record id.

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

Company Entity Watcher Person Entity Watcher Test a discovery watch Update an entity watch List entity watches

⌘I