Skip to main content

What Cymph uses it for

Requirements

To generate an API key, follow the instructions here.

Permissions

What Cymph reads and writes

Everything goes through the Table API (/api/now/v2/table/{table}) on the configured instance URL, authenticated with the API key in the X-SN-APIKEY header. A ServiceNow admin can grant access table by table from this list.

Reads

Imported playbooks are stored in Cymph like any other imported playbook, and re-read on sync. Security incidents are read on demand and never stored: the case, its journal, its tasks and its review are handed to the assistant for the request that asked for them and then discarded. If the key can read the incident but not its journal, tasks or review, those parts are returned empty with a warning instead of failing the read.

Writes

Deploying a playbook inserts one record per action step into the task table you pick in the Deploy dialog. Start, parallel and end steps structure the workflow and create nothing. Each record is populated as follows: Every step must have an assigned entity in Cymph, and only manual commands can be deployed. A playbook with an unassigned step, any other command type, or a nested playbook fails translation before anything is written.
Deploying the same playbook again creates a new set of records. Cymph does not look for records it created earlier, and it never updates or deletes anything in ServiceNow. The deploy history links each step to the record it created.

Testing the connection

Test Connection reads the glide.war row from sys_properties, which identifies the instance build. Failures are shown as Test failed: followed by one of the messages below. Self-signed certificates are accepted; Cymph does not reject an instance because its certificate is untrusted.
Test Connection only proves the key can read one system property. It does not check write access to the task table you will deploy into, or read access to the Process Automation Designer and Security Incident Response tables. Those failures surface later, as Authorization failed in the Deploy dialog, the import dialog or the assistant.