Skip to content

cloudthinker-ai/CloudSkills / skills/connections/managing-knock

managing-knock

Verified

Use when working with Knock — knock notification infrastructure management covering workflows, channels, users, messages, and delivery analytics. Use when monitoring notification delivery, analyzing workflow performance, reviewing channel health, managing notification preferences, or troubleshooting Knock notification issues.

Knock Management Skill

Manage and analyze Knock notification infrastructure including workflows, channels, and delivery.

API Conventions

Authentication

All API calls use Bearer secret key, injected automatically.

Base URL

https://api.knock.app/v1

Core Helper Function

#!/bin/bash

knock_api() {
    local method="$1"
    local endpoint="$2"
    local data="${3:-}"

    if [ -n "$data" ]; then
        curl -s -X "$method" \
            -H "Authorization: Bearer $KNOCK_SECRET_KEY" \
            -H "Content-Type: application/json" \
            "https://api.knock.app/v1${endpoint}" \
            -d "$data"
    else
        curl -s -X "$method" \
            -H "Authorization: Bearer $KNOCK_SECRET_KEY" \
            "https://api.knock.app/v1${endpoint}"
    fi
}

Output Rules

  • Target ≤50 lines per script output
  • Use jq to extract only needed fields
  • Never dump full API responses

Phase 1: Discovery

#!/bin/bash
echo "=== Workflows ==="
knock_api GET "/workflows?page_size=20" \
    | jq -r '.entries[] | "\(.key)\t\(.name)\t\(.active)\t\(.updated_at[0:10])"' \
    | column -t | head -15

echo ""
echo "=== Channels ==="
knock_api GET "/channels" \
    | jq -r '.[] | "\(.id[0:16])\t\(.key)\t\(.type)\t\(.provider)"' \
    | column -t | head -15

echo ""
echo "=== Recent Messages ==="
knock_api GET "/messages?page_size=20" \
    | jq -r '.entries[] | "\(.id[0:16])\t\(.channel_id[0:12])\t\(.status)\t\(.workflow)\t\(.inserted_at[0:16])"' \
    | column -t | head -20

Phase 2: Analysis

Delivery Analytics

#!/bin/bash
echo "=== Message Delivery Summary ==="
knock_api GET "/messages?page_size=100" \
    | jq -r '.entries[] | .status' | sort | uniq -c | sort -rn

echo ""
echo "=== Messages by Channel ==="
knock_api GET "/messages?page_size=100" \
    | jq -r '.entries[] | .channel_id' | sort | uniq -c | sort -rn | head -10

echo ""
echo "=== Messages by Workflow ==="
knock_api GET "/messages?page_size=100" \
    | jq -r '.entries[] | .workflow // "unknown"' | sort | uniq -c | sort -rn | head -10

echo ""
echo "=== Failed/Bounced Messages ==="
knock_api GET "/messages?page_size=20&status=bounced,undelivered" \
    | jq -r '.entries[] | "\(.id[0:16])\t\(.status)\t\(.workflow)\t\(.recipient.id[0:16])\t\(.inserted_at[0:16])"' \
    | head -10

User Preferences

#!/bin/bash
echo "=== Sample User Preferences ==="
knock_api GET "/users?page_size=10" \
    | jq -r '.entries[].id' | while read uid; do
    PREFS=$(knock_api GET "/users/$uid/preferences" | jq -c '.default // {}')
    echo "$uid: $PREFS"
done | head -10

echo ""
echo "=== Users with Custom Preferences ==="
knock_api GET "/users?page_size=50" \
    | jq '[.entries[] | select(.preferences != null)] | length | "Users with preferences: \(.)"'

Output Format

=== Knock Environment ===
Workflows: <n>  Channels: <n>

--- Message Delivery ---
delivered: <n>  sent: <n>  bounced: <n>  undelivered: <n>

--- By Workflow ---
<workflow>: <n> messages

--- By Channel ---
<channel>: <n> messages

Anti-Hallucination Rules

  1. NEVER assume resource names — always discover via CLI/API in Phase 1 before referencing in Phase 2.
  2. NEVER fabricate metric names or dimensions — verify against the service documentation or --help output.
  3. NEVER mix CLI commands between service versions — confirm which version/API you are targeting.
  4. ALWAYS use the discovery → verify → analyze chain — every resource referenced must have been discovered first.
  5. ALWAYS handle empty results gracefully — an empty response is valid data, not an error to retry.

Counter-Rationalizations

ShortcutCounterWhy
"I'll skip discovery and check known resources"Always run Phase 1 discovery firstResource names change, new resources appear — assumed names cause errors
"The user only asked for a quick check"Follow the full discovery → analysis flowQuick checks miss critical issues; structured analysis catches silent failures
"Default configuration is probably fine"Audit configuration explicitlyDefaults often leave logging, security, and optimization features disabled
"Metrics aren't needed for this"Always check relevant metrics when availableAPI/CLI responses show current state; metrics reveal trends and intermittent issues
"I don't have access to that"Try the command and report the actual errorAssumed permission failures prevent useful investigation; actual errors are informative

Common Pitfalls

  • Environment scoping: Secret key is scoped to development or production environment
  • Pagination: Use page_size and after cursor; check page_info.after for next page
  • Message statuses: queued, sent, delivered, undelivered, bounced, seen, read
  • Rate limits: 100 requests/second for most endpoints
  • Workflow keys: Use workflow key (slug), not ID, for most workflow operations
writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deploymentStars: 318kUpdated Claude CodeCodexVerifiedInstall
xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy.Stars: 118kUpdated Claude CodeCodexVerifiedInstall
childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release.Stars: 117kUpdated Claude CodeCodexVerifiedInstall