playbooks

Get Playbook

Changed on

Fetch a single playbook configuration and run stats.

Requires the sequences:read scope on the API key.

get/v1/playbooks/{playbook_id}

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/playbooks/{playbook_id}
  • Auth: HTTP bearer

Path parameters

playbook_idstring uuid required

ID of the playbook.

Response

Successful Response

idstring uuid required

Unique identifier of the playbook.

namestring required

Name of the playbook.

status'DRAFT' | 'ENABLED' | 'PAUSED' required
trigger_type'SIGNAL' | 'SCHEDULE' | 'EVENT' | 'INBOUND_REPLY' | 'MANUAL' | 'CSV' | 'LEAD_IMPORT_COMPLETED' | 'ACTIVITY' required

Changes

  • 3535956158d8Revision changes
    • warning

      added the new ACTIVITY enum value to the response property for the response status

  • 793d8d4affc7Revision changes
    • warning

      added the new LEAD_IMPORT_COMPLETED enum value to the response property for the response status