Documentation / API Jobs and Automation / Deployment Pipeline Workflow

Deployment Pipeline Workflow

Use API checks in CI/CD after deployment to confirm runtime, websites, tasks, and jobs reached expected states.

Use API checks in CI/CD after deployment to confirm runtime, websites, tasks, and jobs reached expected states.

Coverage

ItemStatus
Read website stateUse deployed route documentation
Read PHP runtimeUse deployed route documentation
Read app tasksUse deployed route documentation
Read jobsUse deployed route documentation
Fail the pipeline on unexpected statesUse deployed route documentation

Workflow

  1. Confirm each route against the deployed route documentation.
  2. Test with a staging token first.
  3. Use read endpoints to inspect current state before any write operation.
  4. Record the external workflow ID in your own system.
  5. Review jobs, request logs, and audit logs after the workflow runs.

Notes

  • Do not create production automation around undocumented routes.
  • Use idempotency keys for write endpoints.
  • Keep rollback steps documented with the integration runbook.

Diagram

flowchart TD
    A[External System] --> B[Read Current State]
    B --> C{Expected State?}
    C -- No --> D[Stop and Alert]
    C -- Yes --> E[Run Approved Workflow]
    E --> F[Read Jobs and Logs]
    F --> G[Operator Review]
← Job Queue Concepts