Send Test Delivery

Send a synthetic delivery to your registered webhook endpoint.

POST /webhooks/indexing/test

Python SDK

result = client.webhooks.test()
print(result.data.delivered, result.data.status_code)

200

{
  "data": {
    "delivered": true,
    "message": "Success",
    "status_code": 200
  },
  "error": null,
  "meta": {
    "collection": "team_docs",
    "database": "acme_corp",
    "latency_ms": 12.3,
    "request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
    "source_type": "file",
    "sub_tenant_id": "team_docs",
    "tenant_id": "acme_corp"
  },
  "success": true
}

Sends a synthetic indexing.status_changed payload to your registered endpoint so you can confirm it is reachable and that your signature verification works.

The test payload carries "test": true, and is signed exactly like a real delivery when a signing secret is configured. Use it to check your verifier before relying on it in production. The response reports whether your endpoint accepted it (delivered) and the HTTP status_code it returned. If no webhook is registered, the call returns 404.

Test deliveries do not appear in the delivery history returned by List Deliveries.

See Webhooks for the full payload shape.

Python SDK

result = client.webhooks.test()
print(result.data.delivered, result.data.status_code)

Authorizations

Authorization · string · header · required

API key sent as a Bearer token: "Bearer prefix.secret"

Response

200

application/json

OK

data · object

Show child attributes

Example:

{
  "delivered": true,
  "message": "Success",
  "status_code": 200
}

error · object | null

Null on success; an object with code and message on failure.

Show child attributes

Example:

null

meta · object

Show child attributes

Example:

{
  "collection": "team_docs",
  "database": "acme_corp",
  "latency_ms": 12.3,
  "request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
  "source_type": "file",
  "sub_tenant_id": "team_docs",
  "tenant_id": "acme_corp"
}

success · boolean

Whether the request succeeded.

Example:

true