Servicenow module

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

Table API

Variable	Description	Status
SERVICENOW_INSTANCE_URL	Required for authentication.	required
SERVICENOW_USERNAME	Required for authentication.	required
SERVICENOW_PASSWORD	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave servicenow --help
weave doctor   # reports SERVICENOW_INSTANCE_URL status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
change-request	·	✓	·	·	·	·	·
ci	·	✓	·	·	·	·	·
incident	✓	✓	·	✓	✓	✓	✓
user	·	✓	·	·	·	·	·

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

find (1)

find incident

read

Find an incident by number (INC...).

weave servicenow find incident <number>

list (4)

list changes

read

List change requests.

weave servicenow list changes <arg>

list cis

read

List configuration items.

weave servicenow list cis <arg>

list incidents

read

List recent incidents.

weave servicenow list incidents <arg>

list users

read

List users.

weave servicenow list users <arg>

do (2)

do close

write

Close an incident (state 7 + resolution code/notes).

weave servicenow do close <number>

do resolve

write

Resolve an incident (state 6 + resolution code/notes).

weave servicenow do resolve <number>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/servicenow/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

incidents

snapshot diff apply

ServiceNow incidents — state / short_description via Table API PATCH.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: servicenow
kind: incidents
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Incidents audit

Snapshot and diff incidents.

weave servicenow snapshot incidents
$EDITOR .weave-state/servicenow/incidents.yaml
weave servicenow diff incidents
weave servicenow apply incidents

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
servicenow_incidents	weave servicenow snapshot/diff/apply incidents Snapshot/diff for audit; confirm apply on the module page.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including SERVICENOW_INSTANCE_URL) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave servicenow diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/servicenow. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.