ServiceNow
Check a ServiceNow change request's state before a pipeline step runs, and read change requests from agent work.
Connect it with: User name and password. ServiceNow's own documentation: https://developer.servicenow.com/dev.do#!/reference/api/latest/rest/c_TableAPI.
What agents can do
Connect ServiceNow so the agents working your tasks can reach it. With it connected, they can:
- Hold a pipeline step until a change request reaches an approved state, such as Scheduled or Implement.
- Ask for a change number when someone presses a deploy, and check that change before it runs.
- Read change requests and their states to answer questions about upcoming releases.
Before you start
- A ServiceNow instance reachable from the internet over https.
- A ServiceNow user with read access to the change_request and sys_choice tables (the itil role covers both).
- A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.
Connect with ServiceNow
Jaah connects to ServiceNow with a user name and password, not with a sign-in button.
Connect with an API key
Find each value first:
- Instance URL: The address you open ServiceNow at, such as https://acme.service-now.com, with nothing after it.
- User name: The ServiceNow user Jaah signs in as (User Administration > Users > User ID). Give it a role that may read the change_request and sys_choice tables, such as itil.
- Password: That user's password. Tick Web service access only on the user record so it cannot sign in to the web interface.
Then add it to Jaah:
- In Jaah, open Secrets, select New, and pick the ServiceNow card.
- Name the secret and choose who can use it.
- Fill in Instance URL, User name, Password.
- Select Save. Jaah tests the secret straight away (see Test the connection).
Jaah encrypts what you type and never shows it again — not to you, and not to an admin.
Use your own OAuth app
Not used: Jaah connects to ServiceNow with a user name and password, not through an OAuth app.
Test the connection
Select Test on the secret. Jaah calls ServiceNow's API once (GET <Instance URL>/api/now/table/change_request?sysparm_limit=1&sysparm_fields=number) with the stored values, and shows whether ServiceNow accepted it, or which value ServiceNow refused and the status it answered. Jaah also tests automatically when you save or reconnect.
The last result and its time stay on the secret's page, so you can see whether it still works without testing again.
Who can use it
Every secret has an owner, and the owner decides who can use it:
- Personal — only your own tasks can use it. This is the default.
- Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
- Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.
More on owners and access: How secrets work.
Use it in an agent session
An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:
org/<name>for an organization secret,projects/<project>/<name>for one attached to a project,me/<name>for your personal one.
A key connection hands the agent its fields: instance_url, username, password.
Tell the agent in your task description which secret to use, for example “use the ServiceNow secret org/servicenow”.
Manage, rotate or disconnect
Everything is on the secret's page under Secrets:
- Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at ServiceNow once the test passes. Steps: Replace or delete a secret.
- Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at ServiceNow's side too, change the password at ServiceNow or remove the user.
Limitations
- Only Basic authentication (user name and password) is supported; OAuth and multi-factor sign-in are not.
- The instance must be reachable from the internet over https: Jaah refuses private and intranet addresses.
- Jaah reads change requests only: it never approves, moves or edits one.
- Agents can do only what the connected ServiceNow account allows.
Troubleshooting
Test says ServiceNow rejected the login (401)
The user name or password is wrong, or the user is locked out. Check both on the user record and select Replace.
Test answers 403
The user may not read the change_request table. Give it the itil role, or a role with read access to change_request and sys_choice.
Test cannot reach the instance
Instance URL must be the public https address, such as https://acme.service-now.com, with nothing after it.
Still stuck? Select Test and read the result: it names the value ServiceNow refused and the status it answered.
FAQ
Which states can a ticket gate wait for?
Any state of the change request table. Settings > Pipeline lists them from your instance once you pick this credential.
Can Jaah or an admin see the key or token?
No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.
Can I connect more than one ServiceNow account?
Yes. Add one secret per account, each with its own name, and tell the agent which one to use.