v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Playbooks

Retrieve a Playbook Run

Retrieves data about a Playbook run.

get/v2.0/playbooks/{playbookId}/runs/{playbookRunId}

Path parameters

playbookIdstring required

The unique identifier for the Playbook.

playbookRunIdstring required

The unique identifier for the Playbook run.

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.

Response

Returns Playbook run object

status'successful' | 'failed'

Whether the playbook run was successful or failed

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

flowIdstring

Reference Id of the flow

localeIdstring

Reference Id of the locale

entrypointstring

snapshot or project ID

Example response

{
  "status": "successful",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "stepResults": [
    {
      "status": "failed",
      "text": "Hello, how are you?",
      "asserts": [
        {
          "type": "assertText",
          "status": "failed"
        }
      ]
    }
  ],
  "flowId": "uuid",
  "localeId": "uuid",
  "entrypoint": "^[a-z0-9]{24}$"
}