Skip to main content
POST
Check in

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json

Extractor status update.

Request sent on extractor check-in.

externalId
string
required

The external ID provided by the client. Must be unique for the resource type.

Required string length: 1 - 255
Example:

"my.integrations.id"

taskEvents
TaskUpdate · object[]

A list of task updates.

errors
(GeneralError · object | ConfigError · object)[]

A list of errors that occurred since the last checkin.

An error that occurred as part of an extractor run. Reports as general unless a type is set.

actionUpdates
ActionUpdate · object[]

A list of status updates for actions since the last checkin.

Maximum array length: 100

Response

Response with updates for the extractor.

Response sent on extractor check-in.

externalId
string
required

The external ID provided by the client. Must be unique for the resource type.

Required string length: 1 - 255
Example:

"my.integrations.id"

lastConfigRevision
integer

Last stored extractor configuration revision.

pendingActions
Action · object[]

Actions the extractor should pick up and perform, reporting their outcome back via actionUpdates on a subsequent checkin.

Last modified on September 25, 2026