Skip to content
AACSearch

Ingest connector events

Canonical CMS write path. Authenticated by HMAC (`X-Signature-Timestamp` + `X-Signature` over `timestamp.body`), not by API key. Body is one event object or `{ "events": [ ... ] }` (max 500). Events need `external_id` (or `element_id` / `id`); `event: delete` removes the document. Returns counts and a `job_id` for the apply queue.

Full-key operation

Requires a full key; a search key or a browser key gets a 403. See Keys and credits.
POST
/connectors/{connectorId}/webhook

Canonical CMS write path. Authenticated by HMAC (X-Signature-Timestamp + X-Signature over timestamp.body), not by API key. Body is one event object or { "events": [ ... ] } (max 500). Events need external_id (or element_id / id); event: delete removes the document. Returns counts and a job_id for the apply queue.

Path Parameters

connectorId*string

Header Parameters

X-Signature-Timestamp*string
X-Signature*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

One event or a batch. Each event may reserve event_id (a stable string up to 128 characters) and source_revision (a nonnegative safe integer, increasing per source document, including deletions). Repeated or older revisions are ignored; an unversioned event cannot overwrite an already versioned document. These metadata fields are not indexed as document attributes.

One event or a batch. Each event may reserve event_id (a stable string up to 128 characters) and source_revision (a nonnegative safe integer, increasing per source document, including deletions). Repeated or older revisions are ignored; an unversioned event cannot overwrite an already versioned document. These metadata fields are not indexed as document attributes.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/connectors/string/webhook" \  -H "X-Signature-Timestamp: string" \  -H "X-Signature: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "data": {    "received": 0,    "upserted": 0,    "deleted": 0,    "job_id": "string"  }}