Zendesk 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.

Zendesk API

Variable	Description	Status
ZENDESK_SUBDOMAIN	Required for authentication.	required
ZENDESK_EMAIL	Required for authentication.	required
ZENDESK_API_TOKEN	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave zendesk --help
weave doctor   # reports ZENDESK_SUBDOMAIN 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
ticket	✓	✓	·	·	·	·	·
user	·	✓	·	·	✓	✓	✓

Commands

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

find (1)

find ticket

read

Find a ticket by id.

weave zendesk find ticket <ticket-id>

list (2)

list tickets

read

List recent tickets.

weave zendesk list tickets <arg>

list users

read

List users.

weave zendesk list users <arg>

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/zendesk/.

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

users

snapshot diff apply

Zendesk users — name/role/suspended apply via PUT /users/{id}; email is snapshot-only.

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

State file skeleton

module: zendesk
kind: users
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.

Users audit

Snapshot and diff users.

weave zendesk snapshot users
$EDITOR .weave-state/zendesk/users.yaml
weave zendesk diff users
weave zendesk apply users

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
zendesk_users	weave zendesk snapshot/diff/apply users Snapshot/diff for audit; confirm apply on the module page.

Troubleshooting & source

Missing credentials

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

Unexpected behaviour from a state apply

Re-run weave zendesk 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/zendesk. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.