Back to Datadog API v2
Datadog API v2

CIAppPipelineEventJob schema restructured; FinishedPipeline required field added

BreakingBreaking change

This is a breaking change — integrations that rely on the affected behaviour will need updates before the change rolls out.

What changed

Several breaking changes to CI App pipeline event schemas:

  • CIAppPipelineEventJob was previously a concrete object schema; it is now a oneOf union of CIAppPipelineEventFinishedJob and CIAppPipelineEventInProgressJob. Clients that previously used the flat schema will need to handle both variants.
  • CIAppPipelineEventFinishedPipeline gains a new required field end, which was previously already present but not listed as required — clients sending pipeline-finished events that omit end will now be rejected.
  • CIAppPipelineEventFinishedJob (new schema, extracted from the old CIAppPipelineEventJob) changes required fields: unique_idid, and adds pipeline_unique_id and pipeline_name as required; removes partial_retry as required.
  • CIAppPipelineEventInProgressJob (new schema, extracted from the old CIAppPipelineEventJob) changes its status reference from CIAppPipelineEventJobStatus to the new CIAppPipelineEventJobInProgressStatus (enum ["running"]), and drops end from required fields.
  • New schema CIAppPipelineEventJobInProgressStatus added with enum value running.

Open the source documentation