v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Playbooks

Schedule a Playbook Run

Schedules a Playbook run.

post/v2.0/playbooks/{playbookId}/schedule

Path parameters

playbookIdstring required

The unique identifier for the Playbook.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

entrypointstring

The unique identifier for the Snapshot or Project used for the Playbook run.

flowIdstring

The Flow ID for the Playbook run.

localeIdstring

The Locale ID for the Playbook run.

Example request

{
  "entrypoint": "61f25579055c2f43c249a181",
  "flowId": "010d1970-89b9-4012-892b-53c78ef6c117",
  "localeId": "8b3b45e2-48f9-446d-a4c5-35d8284a01b2"
}

Response

Playbook run successfully scheduled.

_idstring

statusstring

Task status (e.g. queued, active, done)

typestring

Task type (e.g. runPlaybook)

parametersobject

Task payload (playbookId, projectId, entrypoint, flowId, localeId, etc.)

createdAtnumber

Unix timestamp in seconds when the task was created

lastChangedAtnumber

Unix timestamp in seconds when the task was last updated

progressinteger

Task progress (0-100)

Example response

{
  "status": "queued",
  "type": "runPlaybook"
}