Skip to content

Real-world use-case catalog

The examples/ directory provides executable scripts. They utilize environment variables, omit hard-coded credentials, and implement reconciliation for non-idempotent writes.

Example Purpose Main API domains
project_bootstrap.php Provision or reconcile a project and board projects, boards
ci_cd_release_workflow.php Track releases from CI to deployment tickets, boards, comments, notifications
incident_response.php Create and escalate critical incident tickets tickets, boards, notifications
document_publish_pipeline.php Sync version-controlled HTML to documents documents, comments
analytics_report.php Generate cross-project CSV reports projects, analytics
ticket_export.php Paginate and export all tickets tickets
external_ticket_sync.php Reconcile external issues using stable markers tickets
custom_transport.php Inject an application PSR-18 transport transport

Shared environment

Standard configuration:

export OKATANA_URL="https://your-okatana-deployment.example"
export OKATANA_TOKEN="oka_public.secret"
export OKATANA_ORG="01..."

Test credential scopes in a staging organization before execution. Certain scripts modify resources.