Fathom Debug Bundle

Fathom Debug Bundle

Prerequisites

• An issue owner, affected environment, approved incident/support destination, and strict redaction policy for meeting content and credentials.

Instructions

1. Collect only correlation IDs, environment, versions, configuration state, status classes, and aggregate timing.
2. Review the bundle for recordings, transcripts, participant data, CRM records, tokens, and private links before distribution.
3. Reproduce with a synthetic meeting/test account and retain the minimum approved evidence.

Output

• A minimal redacted diagnostic bundle with owner, scope, evidence, and safe escalation/recovery path.

Error Handling

Examples

For a CRM-sync failure, collect opaque meeting/action IDs, environment, mapping version, status class, and timestamp, then reproduce with a synthetic record. Do not attach recordings, transcript text, contact details, or tokens to the case.

Overview

Collect Fathom API connectivity status, meeting recording metadata, transcript availability, and authentication state into a single diagnostic archive. This bundle helps troubleshoot missing transcripts, failed meeting syncs, webhook delivery issues, and API authentication problems. Attach the output to Fathom support tickets so engineers can diagnose integration failures without back-and-forth.

Debug Collection Script

#!/bin/bash
set -euo pipefail
BUNDLE="debug-fathom-$(date +%Y%m%d-%H%M%S)"
mkdir -p "$BUNDLE"

# Environment check
echo "=== Fathom Debug Bundle ===" | tee "$BUNDLE/summary.txt"
echo "Generated: $(date -u +%Y-%m-%dT%H:%M:%SZ)" >> "$BUNDLE/summary.txt"
echo "FATHOM_API_KEY: ${FATHOM_API_KEY:+[SET]}" >> "$BUNDLE/summary.txt"

# API connectivity
HTTP=$(curl -s -o /dev/null -w "%{http_code}" \
  -H "X-Api-Key: ${FATHOM_API_KEY}" \
  https://api.fathom.ai/external/v1/meetings?limit=1 2>/dev/null || echo "000")
echo "API Status: HTTP $HTTP" >> "$BUNDLE/summary.txt"

# Recent meetings (last 5)
curl -s -H "X-Api-Key: ${FATHOM_API_KEY}" \
  "https://api.fathom.ai/external/v1/meetings?limit=5" \
  > "$BUNDLE/recent-meetings.json" 2>&1 || true

# Check transcript availability for latest meeting
MEETING_ID=$(curl -s -H "X-Api-Key: ${FATHOM_API_KEY}" \
  "https://api.fathom.ai/external/v1/meetings?limit=1" 2>/dev/null \
  | jq -r '.meetings[0].id // empty' 2>/dev/null || true)
if [ -n "$MEETING_ID" ]; then
  curl -s -H "X-Api-Key: ${FATHOM_API_KEY}" \
    "https://api.fathom.ai/external/v1/meetings/$MEETING_ID/transcript" \
    > "$BUNDLE/latest-transcript-status.json" 2>&1 || true
fi

# Rate limit headers
curl -s -D "$BUNDLE/rate-headers.txt" -o /dev/null \
  -H "X-Api-Key: ${FATHOM_API_KEY}" \
  https://api.fathom.ai/external/v1/meetings?limit=1 2>/dev/null || true

tar -czf "$BUNDLE.tar.gz" "$BUNDLE" && rm -rf "$BUNDLE"
echo "Bundle: $BUNDLE.tar.gz"

Analyzing the Bundle

tar -xzf debug-fathom-*.tar.gz
cat debug-fathom-*/summary.txt                    # API auth + connectivity
jq '.meetings[] | {id, title, created_at}' debug-fathom-*/recent-meetings.json
grep -i "ratelimit\|retry" debug-fathom-*/rate-headers.txt

Common Issues

Automated Health Check

async function checkFathom(): Promise<void> {
  const key = process.env.FATHOM_API_KEY;
  if (!key) { console.error("[FAIL] FATHOM_API_KEY not set"); return; }

  const res = await fetch("https://api.fathom.ai/external/v1/meetings?limit=1", {
    headers: { "X-Api-Key": key },
  });
  console.log(`[${res.ok ? "OK" : "FAIL"}] API: HTTP ${res.status}`);

  if (res.ok) {
    const data = await res.json();
    console.log(`[INFO] Meetings accessible: ${data.meetings?.length ?? 0} returned`);
  }
  const remaining = res.headers.get("x-ratelimit-remaining");
  if (remaining) console.log(`[INFO] Rate limit remaining: ${remaining}`);
}
checkFathom();

Resources

• Fathom Status

Next Steps

See fathom-common-errors for transcript sync and webhook troubleshooting patterns.