Endpoints

ingest endpoint post /api/webhook/ingest/{ingest endpoint uuid} authentication bearer token in authorization header body json payload (see field mapping) rate limits default is 120 requests/minute responses 200 accepted request stored and queued for processing 422 unprocessable entity validation failed 401 unauthorized invalid/expired/missing token 429 too many requests rate limit exceeded ingest test endpoint post /api/webhook/ingest/{ingest endpoint uuid}/test this validates a payload without persisting it use this to check whether a request would be accepted by the configured mapping and validation rules available only for people type ingesting validation ingest endpoints can be configured with customised schema validation this reduces bad data by rejecting invalid requests early if a request fails to pass validation, a 422 response is provided with some additional messaging { 	"message" "invalid", 	"success" false, 	"error type" "validation error", 	"errors" "the provided payload is not in the correct format for this endpoint" } considerations requests are processed asynchronously 200 accepted means queued, not processed no automatic deduplication; upstream systems should send unique identifiers (organisation uid) if required event ordering is not guaranteed; jobs are processed as picked from the queue people import type is labeled as ingest api in reporting so you can understand which records were ingested via this api