fix(servicenow): stop constant interpolation leaking into tool descriptions

The docs generator and the client-facing integration catalog read tool
descriptions from source rather than from the evaluated module, so a
template literal like `state ${INCIDENT_STATE.RESOLVED}` shipped to users
verbatim: `apps/sim/lib/integrations/integrations.json` and the published
ServiceNow integration page both rendered `${INCIDENT_STATE.RESOLVED}`
instead of `6`. Inline the base-system coded values in the description
text; the constants stay in use everywhere behavior depends on them.

Also drops an escaped `\'` in the `inputDisplayValue` description for the
same reason, and adds a standing guard test asserting no subBlock id
carries two different seeded defaults — the invariant behind the
per-operation defaulting bug, now checked structurally rather than only
through the four per-operation cases.

Author: waleedlatif1

apps/docs/content/docs/en/integrations/servicenow.mdx

@@ -239,7 +239,7 @@ Create an incident in ServiceNow. Reference fields (caller, assignment group, as
 | `impact` | string | No | Impact: 1 \(High\), 2 \(Medium\), or 3 \(Low\). |
 | `urgency` | string | No | Urgency: 1 \(High\), 2 \(Medium\), or 3 \(Low\). |
 | `priority` | string | No | Priority 1-5 \(1 Critical … 5 Planning\). Normally derived from impact and urgency, so prefer setting those. |
-| `state` | string | No | Incident state coded value. Base system: $\{INCIDENT_STATE.NEW\}=New, $\{INCIDENT_STATE.IN_PROGRESS\}=In Progress, $\{INCIDENT_STATE.ON_HOLD\}=On Hold, $\{INCIDENT_STATE.RESOLVED\}=Resolved, $\{INCIDENT_STATE.CLOSED\}=Closed, $\{INCIDENT_STATE.CANCELED\}=Canceled. Defaults to New. |
+| `state` | string | No | Incident state coded value. Base system: 1=New, 2=In Progress, 3=On Hold, 6=Resolved, 7=Closed, 8=Canceled. Defaults to New. |
 | `assignmentGroup` | string | No | Assignment group \(assignment_group\) — sys_id of the sys_user_group. |
 | `assignedTo` | string | No | Assigned to \(assigned_to\) — sys_id of the sys_user. |
 | `cmdbCi` | string | No | Configuration item \(cmdb_ci\) — sys_id of the affected CI. |
@@ -330,7 +330,7 @@ Search ServiceNow incidents by state, priority, assignment, caller, or text. All
 | Parameter | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
 | `searchText` | string | No | Text to match against the incident short description using the ServiceNow LIKE operator, which matches anywhere in the field. |
-| `state` | string | No | Incident state coded value. Base system: $\{INCIDENT_STATE.NEW\}=New, $\{INCIDENT_STATE.IN_PROGRESS\}=In Progress, $\{INCIDENT_STATE.ON_HOLD\}=On Hold, $\{INCIDENT_STATE.RESOLVED\}=Resolved, $\{INCIDENT_STATE.CLOSED\}=Closed, $\{INCIDENT_STATE.CANCELED\}=Canceled. |
+| `state` | string | No | Incident state coded value. Base system: 1=New, 2=In Progress, 3=On Hold, 6=Resolved, 7=Closed, 8=Canceled. |
 | `priority` | string | No | Priority coded value 1-5 \(1 Critical … 5 Planning\). |
 | `assignmentGroup` | string | No | sys_id of the assignment group. |
 | `assignedTo` | string | No | sys_id of the assigned user. |
@@ -379,7 +379,7 @@ Update fields on an existing ServiceNow incident. Only the fields you supply are
 | --------- | ---- | -------- | ----------- |
 | `shortDescription` | string | No | New short description. |
 | `description` | string | No | New detailed description. |
-| `state` | string | No | Incident state coded value. Base system: $\{INCIDENT_STATE.NEW\}=New, $\{INCIDENT_STATE.IN_PROGRESS\}=In Progress, $\{INCIDENT_STATE.ON_HOLD\}=On Hold, $\{INCIDENT_STATE.RESOLVED\}=Resolved, $\{INCIDENT_STATE.CLOSED\}=Closed, $\{INCIDENT_STATE.CANCELED\}=Canceled. Use Resolve or Close ServiceNow Incident for those transitions so the resolution fields are populated. |
+| `state` | string | No | Incident state coded value. Base system: 1=New, 2=In Progress, 3=On Hold, 6=Resolved, 7=Closed, 8=Canceled. Use Resolve or Close ServiceNow Incident for those transitions so the resolution fields are populated. |
 | `impact` | string | No | Impact: 1 \(High\), 2 \(Medium\), or 3 \(Low\). |
 | `urgency` | string | No | Urgency: 1 \(High\), 2 \(Medium\), or 3 \(Low\). |
 | `priority` | string | No | Priority coded value 1-5 \(1 Critical … 5 Planning\). |
@@ -425,7 +425,7 @@ Update fields on an existing ServiceNow incident. Only the fields you supply are
 
 ### Resolve ServiceNow Incident
 
-Move a ServiceNow incident to Resolved (state $\{INCIDENT_STATE.RESOLVED\}) with a resolution code and resolution notes.
+Move a ServiceNow incident to Resolved (state 6) with a resolution code and resolution notes.
 
 #### Input
 
@@ -469,7 +469,7 @@ Move a ServiceNow incident to Resolved (state $\{INCIDENT_STATE.RESOLVED\}) with
 
 ### Close ServiceNow Incident
 
-Move a ServiceNow incident to Closed (state $\{INCIDENT_STATE.CLOSED\}) with a resolution code and resolution notes. Closing normally requires the itil_admin or admin role.
+Move a ServiceNow incident to Closed (state 7) with a resolution code and resolution notes. Closing normally requires the itil_admin or admin role.
 
 #### Input
 
@@ -662,7 +662,7 @@ Search ServiceNow change requests by state, type, risk, assignment, or text. All
 | Parameter | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
 | `searchText` | string | No | Text to match against the change short description using the ServiceNow LIKE operator, which matches anywhere in the field. |
-| `state` | string | No | Change state coded value. Base system: $\{CHANGE_STATE.NEW\}=New, $\{CHANGE_STATE.ASSESS\}=Assess, $\{CHANGE_STATE.AUTHORIZE\}=Authorize, $\{CHANGE_STATE.SCHEDULED\}=Scheduled, $\{CHANGE_STATE.IMPLEMENT\}=Implement, $\{CHANGE_STATE.REVIEW\}=Review, $\{CHANGE_STATE.CLOSED\}=Closed, $\{CHANGE_STATE.CANCELED\}=Canceled. |
+| `state` | string | No | Change state coded value. Base system: -5=New, -4=Assess, -3=Authorize, -2=Scheduled, -1=Implement, 0=Review, 3=Closed, 4=Canceled. |
 | `type` | string | No | Change type: "normal", "standard", or "emergency". |
 | `risk` | string | No | Risk coded value. The choice list is configured per instance. |
 | `assignmentGroup` | string | No | sys_id of the assignment group. |
@@ -711,7 +711,7 @@ Update fields on an existing ServiceNow change request. Only the fields you supp
 | --------- | ---- | -------- | ----------- |
 | `shortDescription` | string | No | New short description. |
 | `description` | string | No | New detailed description. |
-| `state` | string | No | Change state coded value. Base system: $\{CHANGE_STATE.NEW\}=New, $\{CHANGE_STATE.ASSESS\}=Assess, $\{CHANGE_STATE.AUTHORIZE\}=Authorize, $\{CHANGE_STATE.SCHEDULED\}=Scheduled, $\{CHANGE_STATE.IMPLEMENT\}=Implement, $\{CHANGE_STATE.REVIEW\}=Review, $\{CHANGE_STATE.CLOSED\}=Closed, $\{CHANGE_STATE.CANCELED\}=Canceled. |
+| `state` | string | No | Change state coded value. Base system: -5=New, -4=Assess, -3=Authorize, -2=Scheduled, -1=Implement, 0=Review, 3=Closed, 4=Canceled. |
 | `risk` | string | No | Risk coded value. The choice list is configured per instance. |
 | `impact` | string | No | Impact: 1 \(High\), 2 \(Medium\), or 3 \(Low\). |
 | `priority` | string | No | Priority coded value 1-5 \(1 Critical … 5 Planning\). |
@@ -757,14 +757,14 @@ Update fields on an existing ServiceNow change request. Only the fields you supp
 
 ### Move ServiceNow Change State
 
-Move a ServiceNow change request to another state. Base-system change model states are $\{CHANGE_STATE.NEW\}=New, $\{CHANGE_STATE.ASSESS\}=Assess, $\{CHANGE_STATE.AUTHORIZE\}=Authorize, $\{CHANGE_STATE.SCHEDULED\}=Scheduled, $\{CHANGE_STATE.IMPLEMENT\}=Implement, $\{CHANGE_STATE.REVIEW\}=Review, $\{CHANGE_STATE.CLOSED\}=Closed, $\{CHANGE_STATE.CANCELED\}=Canceled. The state machine rejects transitions whose conditions are not met.
+Move a ServiceNow change request to another state. Base-system change model states are -5=New, -4=Assess, -3=Authorize, -2=Scheduled, -1=Implement, 0=Review, 3=Closed, 4=Canceled. The state machine rejects transitions whose conditions are not met.
 
 #### Input
 
 | Parameter | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
-| `state` | string | Yes | Target state coded value: $\{CHANGE_STATE.NEW\} \(New\), $\{CHANGE_STATE.ASSESS\} \(Assess\), $\{CHANGE_STATE.AUTHORIZE\} \(Authorize\), $\{CHANGE_STATE.SCHEDULED\} \(Scheduled\), $\{CHANGE_STATE.IMPLEMENT\} \(Implement\), $\{CHANGE_STATE.REVIEW\} \(Review\), $\{CHANGE_STATE.CLOSED\} \(Closed\), or $\{CHANGE_STATE.CANCELED\} \(Canceled\). |
-| `closeCode` | string | No | Close code, required when moving to Closed \($\{CHANGE_STATE.CLOSED\}\): "successful", "successful_issues", or "unsuccessful". |
+| `state` | string | Yes | Target state coded value: -5 \(New\), -4 \(Assess\), -3 \(Authorize\), -2 \(Scheduled\), -1 \(Implement\), 0 \(Review\), 3 \(Closed\), or 4 \(Canceled\). |
+| `closeCode` | string | No | Close code, required when moving to Closed \(3\): "successful", "successful_issues", or "unsuccessful". |
 | `closeNotes` | string | No | Close notes describing the outcome of the change. |
 | `workNotes` | string | No | Internal work note explaining the transition. |
 
@@ -995,14 +995,14 @@ Retrieve a single ServiceNow requested item (RITM) by number (e.g., RITM0010001)
 
 ### List ServiceNow Approvals
 
-List approval records from the ServiceNow Approval [sysapproval_approver] table. Defaults to the "$\{APPROVAL_STATE.REQUESTED\}" state, which is what a user's pending approvals look like.
+List approval records from the ServiceNow Approval [sysapproval_approver] table. Defaults to the "requested" state, which is what a user's pending approvals look like.
 
 #### Input
 
 | Parameter | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
 | `approverSysId` | string | No | sys_id of the approver \(sys_user\) whose approvals should be listed. Use Find ServiceNow User to resolve an email address to a sys_id. |
-| `state` | string | No | Approval state: "$\{APPROVAL_STATE.REQUESTED\}" \(pending, the default\), "$\{APPROVAL_STATE.APPROVED\}", or "$\{APPROVAL_STATE.REJECTED\}". Pass an empty string with a custom query to list every state. |
+| `state` | string | No | Approval state: "requested" \(pending, the default\), "approved", or "rejected". Pass an empty string with a custom query to list every state. |
 | `approvalFor` | string | No | sys_id of the record being approved, matched against the sysapproval reference field. |
 
 #### Output
@@ -1046,7 +1046,7 @@ Approve or reject a ServiceNow approval record by setting its state on the Appro
 | Parameter | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
 | `approvalSysId` | string | Yes | sys_id of the approval record on the sysapproval_approver table. Use List ServiceNow Approvals to find it. |
-| `decision` | string | Yes | Decision to record: "$\{APPROVAL_STATE.APPROVED\}" or "$\{APPROVAL_STATE.REJECTED\}". |
+| `decision` | string | Yes | Decision to record: "approved" or "rejected". |
 | `comments` | string | No | Comment to record alongside the decision. This is a journal field. |
 
 #### Output

apps/sim/blocks/blocks/servicenow.ts

@@ -220,7 +220,11 @@ export const ServiceNowBlock: BlockConfig<ServiceNowResponse> = {
           { text: ', matching', field: 'query' },
         ],
         servicenow_get_change_next_states: [
-          { text: 'Get the next available states for change request', field: 'changeSysId', core: true },
+          {
+            text: 'Get the next available states for change request',
+            field: 'changeSysId',
+            core: true,
+          },
         ],
         servicenow_list_catalog_items: [
           'List catalog items',
@@ -1730,7 +1734,8 @@ Output: {"state": "2", "assigned_to": "john.doe", "work_notes": "Assigned and st
     },
     allowedStates: {
       type: 'json',
-      description: 'State coded values whose transition conditions the change request already meets',
+      description:
+        'State coded values whose transition conditions the change request already meets',
     },
     stateLabels: {
       type: 'json',

apps/sim/lib/integrations/integrations.json

@@ -17984,11 +17984,11 @@
         },
         {
           "name": "Resolve Incident",
-          "description": "Move a ServiceNow incident to Resolved (state ${INCIDENT_STATE.RESOLVED}) with a resolution code and resolution notes."
+          "description": "Move a ServiceNow incident to Resolved (state 6) with a resolution code and resolution notes."
         },
         {
           "name": "Close Incident",
-          "description": "Move a ServiceNow incident to Closed (state ${INCIDENT_STATE.CLOSED}) with a resolution code and resolution notes. Closing normally requires the itil_admin or admin role."
+          "description": "Move a ServiceNow incident to Closed (state 7) with a resolution code and resolution notes. Closing normally requires the itil_admin or admin role."
         },
         {
           "name": "Add Incident Comment",
@@ -18012,7 +18012,7 @@
         },
         {
           "name": "Move Change State",
-          "description": "Move a ServiceNow change request to another state. Base-system change model states are ${CHANGE_STATE.NEW}=New, ${CHANGE_STATE.ASSESS}=Assess, ${CHANGE_STATE.AUTHORIZE}=Authorize, ${CHANGE_STATE.SCHEDULED}=Scheduled, ${CHANGE_STATE.IMPLEMENT}=Implement, ${CHANGE_STATE.REVIEW}=Review, ${CHANGE_STATE.CLOSED}=Closed, ${CHANGE_STATE.CANCELED}=Canceled. The state machine rejects transitions whose conditions are not met."
+          "description": "Move a ServiceNow change request to another state. Base-system change model states are -5=New, -4=Assess, -3=Authorize, -2=Scheduled, -1=Implement, 0=Review, 3=Closed, 4=Canceled. The state machine rejects transitions whose conditions are not met."
         },
         {
           "name": "List Change Tasks",
@@ -18040,7 +18040,7 @@
         },
         {
           "name": "List Approvals",
-          "description": "List approval records from the ServiceNow Approval [sysapproval_approver] table. Defaults to the \"${APPROVAL_STATE.REQUESTED}\" state, which is what a user's pending approvals look like."
+          "description": "List approval records from the ServiceNow Approval [sysapproval_approver] table. Defaults to the \"requested\" state, which is what a user's pending approvals look like."
         },
         {
           "name": "Approve or Reject",

apps/sim/tools/servicenow/close_incident.ts

@@ -24,7 +24,8 @@ export const closeIncidentTool: ToolConfig<
 > = {
   id: 'servicenow_close_incident',
   name: 'Close ServiceNow Incident',
-  description: `Move a ServiceNow incident to Closed (state ${INCIDENT_STATE.CLOSED}) with a resolution code and resolution notes. Closing normally requires the itil_admin or admin role.`,
+  description:
+    'Move a ServiceNow incident to Closed (state 7) with a resolution code and resolution notes. Closing normally requires the itil_admin or admin role.',
   version: '1.0.0',
 
   params: {

apps/sim/tools/servicenow/create_incident.ts

@@ -1,8 +1,4 @@
-import {
-  DEFAULT_DISPLAY_VALUE,
-  INCIDENT_STATE,
-  SERVICENOW_TABLES,
-} from '@/tools/servicenow/constants'
+import { DEFAULT_DISPLAY_VALUE, SERVICENOW_TABLES } from '@/tools/servicenow/constants'
 import {
   additionalFieldsParam,
   authParams,
@@ -89,7 +85,8 @@ export const createIncidentTool: ToolConfig<
       type: 'string',
       required: false,
       visibility: 'user-or-llm',
-      description: `Incident state coded value. Base system: ${INCIDENT_STATE.NEW}=New, ${INCIDENT_STATE.IN_PROGRESS}=In Progress, ${INCIDENT_STATE.ON_HOLD}=On Hold, ${INCIDENT_STATE.RESOLVED}=Resolved, ${INCIDENT_STATE.CLOSED}=Closed, ${INCIDENT_STATE.CANCELED}=Canceled. Defaults to New.`,
+      description:
+        'Incident state coded value. Base system: 1=New, 2=In Progress, 3=On Hold, 6=Resolved, 7=Closed, 8=Canceled. Defaults to New.',
     },
     assignmentGroup: {
       type: 'string',

apps/sim/tools/servicenow/find_user.ts

@@ -39,7 +39,8 @@ export const findUserTool: ToolConfig<ServiceNowFindUserParams, ServiceNowRecord
       type: 'string',
       required: false,
       visibility: 'user-or-llm',
-      description: 'Text to match against the display name using the ServiceNow LIKE operator, which matches anywhere in the field.',
+      description:
+        'Text to match against the display name using the ServiceNow LIKE operator, which matches anywhere in the field.',
     },
     active: {
       type: 'string',

apps/sim/tools/servicenow/list_approvals.ts

@@ -24,7 +24,7 @@ export const listApprovalsTool: ToolConfig<
 > = {
   id: 'servicenow_list_approvals',
   name: 'List ServiceNow Approvals',
-  description: `List approval records from the ServiceNow Approval [sysapproval_approver] table. Defaults to the "${APPROVAL_STATE.REQUESTED}" state, which is what a user's pending approvals look like.`,
+  description: `List approval records from the ServiceNow Approval [sysapproval_approver] table. Defaults to the "requested" state, which is what a user's pending approvals look like.`,
   version: '1.0.0',
 
   params: {
@@ -40,7 +40,8 @@ export const listApprovalsTool: ToolConfig<
       type: 'string',
       required: false,
       visibility: 'user-or-llm',
-      description: `Approval state: "${APPROVAL_STATE.REQUESTED}" (pending, the default), "${APPROVAL_STATE.APPROVED}", or "${APPROVAL_STATE.REJECTED}". Pass an empty string with a custom query to list every state.`,
+      description:
+        'Approval state: "requested" (pending, the default), "approved", or "rejected". Pass an empty string with a custom query to list every state.',
     },
     approvalFor: {
       type: 'string',

apps/sim/tools/servicenow/list_change_requests.ts

@@ -1,8 +1,4 @@
-import {
-  CHANGE_STATE,
-  DEFAULT_DISPLAY_VALUE,
-  SERVICENOW_TABLES,
-} from '@/tools/servicenow/constants'
+import { DEFAULT_DISPLAY_VALUE, SERVICENOW_TABLES } from '@/tools/servicenow/constants'
 import { authParams, listParams, recordListOutputs } from '@/tools/servicenow/params'
 import type {
   ServiceNowListChangesParams,
@@ -34,13 +30,15 @@ export const listChangeRequestsTool: ToolConfig<
       type: 'string',
       required: false,
       visibility: 'user-or-llm',
-      description: 'Text to match against the change short description using the ServiceNow LIKE operator, which matches anywhere in the field.',
+      description:
+        'Text to match against the change short description using the ServiceNow LIKE operator, which matches anywhere in the field.',
     },
     state: {
       type: 'string',
       required: false,
       visibility: 'user-or-llm',
-      description: `Change state coded value. Base system: ${CHANGE_STATE.NEW}=New, ${CHANGE_STATE.ASSESS}=Assess, ${CHANGE_STATE.AUTHORIZE}=Authorize, ${CHANGE_STATE.SCHEDULED}=Scheduled, ${CHANGE_STATE.IMPLEMENT}=Implement, ${CHANGE_STATE.REVIEW}=Review, ${CHANGE_STATE.CLOSED}=Closed, ${CHANGE_STATE.CANCELED}=Canceled.`,
+      description:
+        'Change state coded value. Base system: -5=New, -4=Assess, -3=Authorize, -2=Scheduled, -1=Implement, 0=Review, 3=Closed, 4=Canceled.',
     },
     type: {
       type: 'string',

apps/sim/tools/servicenow/list_incidents.ts

@@ -1,8 +1,4 @@
-import {
-  DEFAULT_DISPLAY_VALUE,
-  INCIDENT_STATE,
-  SERVICENOW_TABLES,
-} from '@/tools/servicenow/constants'
+import { DEFAULT_DISPLAY_VALUE, SERVICENOW_TABLES } from '@/tools/servicenow/constants'
 import { authParams, listParams, recordListOutputs } from '@/tools/servicenow/params'
 import type {
   ServiceNowListIncidentsParams,
@@ -34,13 +30,15 @@ export const listIncidentsTool: ToolConfig<
       type: 'string',
       required: false,
       visibility: 'user-or-llm',
-      description: 'Text to match against the incident short description using the ServiceNow LIKE operator, which matches anywhere in the field.',
+      description:
+        'Text to match against the incident short description using the ServiceNow LIKE operator, which matches anywhere in the field.',
     },
     state: {
       type: 'string',
       required: false,
       visibility: 'user-or-llm',
-      description: `Incident state coded value. Base system: ${INCIDENT_STATE.NEW}=New, ${INCIDENT_STATE.IN_PROGRESS}=In Progress, ${INCIDENT_STATE.ON_HOLD}=On Hold, ${INCIDENT_STATE.RESOLVED}=Resolved, ${INCIDENT_STATE.CLOSED}=Closed, ${INCIDENT_STATE.CANCELED}=Canceled.`,
+      description:
+        'Incident state coded value. Base system: 1=New, 2=In Progress, 3=On Hold, 6=Resolved, 7=Closed, 8=Canceled.',
     },
     priority: {
       type: 'string',

apps/sim/tools/servicenow/params.ts

@@ -83,8 +83,7 @@ export const inputDisplayValueParam: ServiceNowParams = {
     type: 'boolean',
     required: false,
     visibility: 'user-or-llm',
-    description:
-      'Set to true to write display names into reference fields (e.g., assigned_to: "Beth Anglin") and let ServiceNow resolve them to sys_ids. Defaults to false, meaning reference fields must be sys_ids. Note that true also reinterprets date and time values in the requesting user\'s timezone rather than GMT.',
+    description: `Set to true to write display names into reference fields (e.g., assigned_to: "Beth Anglin") and let ServiceNow resolve them to sys_ids. Defaults to false, meaning reference fields must be sys_ids. Note that true also reinterprets date and time values in the requesting user's timezone rather than GMT.`,
   },
 }