playbooks

Get Playbook

get/api/v1/playbooks/{playbook_id}

Path parameters

playbook_idstring uuid required

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
namestring required
descriptionstring nullable
list_idstring uuid required
trigger'on_enter' | 'on_exit' required

Which group-membership transition arms a Playbook.

is_activeboolean required
created_by_user_idstring uuid nullable
created_atstring date-time required
updated_atstring date-time required
action_countinteger

Changes

Changed in 1 of the 5 revisions of this API.2

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog