Workflows

Get data change by ID

get/v4/changes/{changeId}

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/changes/{changeId}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

changeIdstring required

ID of the workflow change to retrieve

Headers

x-api-keystring

API key for authorization

Authorizationstring

Bearer token for authorization

Response

Workflow change returned successfully

idstring

Unique identifier of the change

workflowIdstring

ID of the workflow this change belongs to

dataobject[] nullable

Current state of the data after the change

dataPendingboolean

True when durable change data is still being stored; change events are emitted first so users see changes as fast as possible.

urlstring

URL where the change was detected

summarystring nullable

AI-generated one-sentence summary of the data change. Null if generation failed, feature is disabled, or change predates the feature.

screenshotUrlstring

URL of the screenshot taken when the change was detected

previousJobScreenshotUrlstring nullable

Screenshot URL from the previous workflow job used by visualDiff.previous boxes.

createdAtstring date-time

Timestamp when the change was created

Changes

No recorded changes to this operation across all 1 revision of this API.