界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
开发与工程 · SKILL.md

hex-webhooks-events

hex-webhooks-events

【开发与工程】Implement Hex webhook signature validation and event handling. Use when setting up webhook endpoints, implementing signature verification, or handling Hex event notifications securely. Trigger with phrases like "hex webhook", "hex events", "hex webhook signature", "handle hex events", "hex notifications".

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: hex-webhooks-events description: 'Implement Hex webhook signature validation and event handling.

Use when setting up webhook endpoints, implementing signature verification,

or handling Hex event notifications securely.

Trigger with phrases like "hex webhook", "hex events",

"hex webhook signature", "handle hex events", "hex notifications".

' allowed-tools: Read, Write, Edit, Bash(curl:*) version: 1.6.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io tags:

  • saas
  • hex
  • data
  • analytics compatibility: Designed for Claude Code

Hex Webhooks & Events

Overview

Hex doesn't provide push webhooks. For event-driven integrations, poll run status or build your own notification system around run completions.

Instructions

Run Status Polling with Callback

async function runWithCallback(
  client: HexClient,
  projectId: string,
  params: Record<string, any>,
  onComplete: (result: any) => void,
  onError: (error: Error) => void
) {
  try {
    const { runId } = await client.runProject(projectId, params);
    const poll = async () => {
      const status = await client.getRunStatus(projectId, runId);
      if (status.status === 'COMPLETED') { onComplete(status); return; }
      if (status.status === 'ERRORED' || status.status === 'KILLED') { onError(new Error(status.status)); return; }
      setTimeout(poll, 5000);
    };
    poll();
  } catch (err) { onError(err as Error); }
}

Notify on Completion

runWithCallback(client, 'project-id', { date: '2025-01-01' },
  (result) => {
    // Send Slack notification, email, etc.
    fetch(process.env.SLACK_WEBHOOK_URL!, {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ text: `Hex project completed: ${result.runId}` }),
    });
  },
  (error) => console.error('Run failed:', error)
);

Prerequisites

  • A secret-manager webhook secret, origin allowlist, replay-window policy, and opaque event ledger.
  • A sandbox receiver plus a tested disable/cancel control for downstream project execution.

Output

Return an event receipt with type, opaque event/run ID, signature/timestamp result, idempotency outcome, queue state, canary result, and rollback reference. Exclude payload data, SQL, output, and signatures.

Error Handling

Reject unknown origin, stale/replayed delivery, malformed payload, unknown project destination, or non-idempotent retry. Quarantine the opaque event and disable the consumer if integrity is uncertain.

Examples

type=run.completed; event=evt-opaque-9; signature=pass; replay=absent; project=proj-sandbox-12; enqueue=once; rollback=consumer-disabled proves the event boundary.

Resources

我的收藏