Webhooks

// Via dashboard settings
workspace.config.webhookUrl = 'https://yourapp.com/api/webhooks/offboard'

// Or via API
await fetch('/api/workspaces/{id}', {
  method: 'PATCH',
  body: JSON.stringify({
    config: { webhookUrl: 'https://yourapp.com/api/webhooks/offboard' }
  })
})

{
  "event": "interview.completed",
  "workspace_id": "ws_abc123",
  "workspace_name": "Acme Inc",
  "interview_id": "int_xyz789",
  "status": "completed",
  "sentiment": "neutral",
  "summary": "Customer is leaving because the service is too expensive compared to competitors.",
  "metadata": {
    "plan": "pro",
    "value": "99",
    "customer_id": "cust_456"
  },
  "created_at": "2024-01-15T10:30:00Z"
}

{
  "event": "interview.saved",
  "workspace_id": "ws_abc123",
  "workspace_name": "Acme Inc",
  "interview_id": "int_xyz789",
  "status": "saved",
  "sentiment": "positive",
  "summary": "Customer considered leaving due to price but accepted 20% discount offer.",
  "metadata": {
    "plan": "pro",
    "save_offer": "20% off for 3 months"
  },
  "created_at": "2024-01-15T10:30:00Z"
}

{
  "event": "interview.abandoned",
  "workspace_id": "ws_abc123",
  "workspace_name": "Acme Inc",
  "interview_id": "int_xyz789",
  "status": "abandoned",
  "sentiment": null,
  "summary": null,
  "metadata": {
    "plan": "pro"
  },
  "created_at": "2024-01-15T10:30:00Z"
}

interface WebhookPayload {
  event: 'interview.completed' | 'interview.saved' | 'interview.abandoned'
  workspace_id: string
  workspace_name: string
  interview_id: string
  status: 'completed' | 'saved' | 'abandoned'
  sentiment: 'positive' | 'neutral' | 'negative' | null
  summary: string | null  // PII-scrubbed summary
  metadata: {
    // URL params from magic link + any additional data
    [key: string]: unknown
  }
  created_at: string  // ISO 8601 timestamp
}

// POST /api/webhooks/offboard
import { NextRequest, NextResponse } from 'next/server'

export async function POST(request: NextRequest) {
  const payload = await request.json()

  switch (payload.event) {
    case 'interview.completed':
      await handleCompleted(payload)
      break
    case 'interview.saved':
      await handleSaved(payload)
      break
    case 'interview.abandoned':
      await handleAbandoned(payload)
      break
  }

  return NextResponse.json({ received: true })
}

async function handleCompleted(payload: WebhookPayload) {
  // Process completed interview
  const customerId = payload.metadata.customer_id as string

  // Update CRM
  await updateCRM(customerId, {
    churn_reason: payload.summary,
    sentiment: payload.sentiment,
    churned_at: new Date(),
  })

  // Cancel subscription
  await cancelSubscription(customerId)
}

async function handleSaved(payload: WebhookPayload) {
  // Customer accepted save offer
  const customerId = payload.metadata.customer_id as string
  const offer = payload.metadata.save_offer as string

  // Apply retention offer
  await applyDiscount(customerId, {
    offer: offer,
    duration: '3 months',
  })

  // Notify sales team
  await notifySales({ customerId, offer, summary: payload.summary })
}

async function handleAbandoned(payload: WebhookPayload) {
  // Customer didn't complete interview
  // Could trigger follow-up email sequence
  await scheduleFollowUp(payload.metadata.customer_id as string)
}

x-offboard-signature: t=1705314600,v1=5257a869e7e8e1a7e2d2e2b8c1f...

import { createHmac, timingSafeEqual } from 'node:crypto'

const [t, v1] = Object.fromEntries(
  request.headers.get('x-offboard-signature')!.split(',').map(kv => kv.split('=', 2))
)
// 1. Reject replays: |now - t| must be ≤ 300 seconds
// 2. Recompute the MAC over the exact raw body
const expected = createHmac('sha256', SECRET).update(`${t}.${rawBody}`).digest('hex')
// 3. Constant-time compare
const ok = timingSafeEqual(Buffer.from(expected), Buffer.from(v1))

curl -X POST https://offboard.tech/api/workspaces/{id}/secrets \
  -H 'Content-Type: application/json' \
  -d '{"generateWebhookSecret": true}'
# → {"webhookSecret":"<hex>"} — response is the only place it's ever shown

curl -X POST https://offboard.tech/api/workspaces/{id}/test-webhook \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://yourapp.com/api/webhooks/offboard"
  }'

# Start ngrok
ngrok http 3000

# Use ngrok URL as webhook URL
https://abc123.ngrok.io/api/webhooks/offboard

// interview.completed
{
  "event": "interview.completed",
  "workspace_id": "test_ws",
  "workspace_name": "Test Workspace",
  "interview_id": "00000000-0000-0000-0000-000000000000",
  "status": "completed",
  "sentiment": "neutral",
  "summary": "This is a test webhook payload.",
  "metadata": { "test": true },
  "created_at": "2024-01-15T10:30:00Z"
}