> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telepatia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar uma assinatura de webhook

> Copie para o Cursor/Claude/Copilot para gerar uma integração POST /v1/webhooks.

Cole este prompt no seu assistente de programação com IA. Ele já inclui o contrato, a autenticação e o envelope de erros, para que o código gerado corresponda à API de produção.

<CodeGroup>
  ```text Prompt theme={null}
  Você está integrando a API pública da Telepatia Synapse.

  Endpoint: POST /v1/webhooks
  Base URL: https://scribe-api.telepatia.ai
  Auth: Authorization: Bearer ${SYNAPSE_API_KEY}

  Requisição:
  - url [body]: string (obrigatório, format=uri, minLength=1, maxLength=2083) — https endpoint that will receive event POSTs.
  - name [body]: string (opcional, maxLength=100) — Optional human-readable label to identify this webhook in lists/UI. Trimmed server-side; a blank value stores no name.
  - events [body]: array<WebhookEventName> (opcional) — Event types to subscribe to (at least one). Preferred over `event`.
  - event [body]: string (opcional, enum: 8 values) — Webhook event types exposed to API clients.

  Mirrors `SynapseWebhookEventType` enum in datalayer (camelCase) but
  rendered to clients as snake_case dotted strings (closer to Stripe
  convention and easier to grep in caller logs).

  Sucesso 200:
  - id: string
  - url: string
  - name?: string
  - events: array<WebhookEventName>
  - event?: string
  - isActive: boolean
  - signingSecretPrefix?: string
  - signingSecretVersion?: integer
  - createdAt?: string
  - updatedAt?: string
  - deletedAt?: string
  - signingSecret: string

  Erros (envelope: { error: { type, code, message, param? } }):
  - 400: parameter_missing, parameter_invalid, account_invalid
  - 401: authentication_required
  - 403: permission_denied, permission_denied_role
  - 503: service_unavailable

  Gere código na linguagem do arquivo atual que:
  1. Leia SYNAPSE_API_KEY do ambiente (não fixe o valor no código).
  2. Chame o endpoint com requisição e resposta tipadas.
  3. Mapeie o envelope de erros para exceções tipadas por código de status.
  4. Adicione um teste de caminho feliz usando o token Bearer.
  ```

  ```bash curl theme={null}
  curl -X POST https://scribe-api.telepatia.ai/v1/webhooks \
    -H "Authorization: Bearer $SYNAPSE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
    "events": [
      "scribe_session.created",
      "scribe_session.completed",
      "scribe_session.error"
    ],
    "name": "Scribe prod webhook",
    "url": "https://example.com/webhooks/scribe"
  }'
  ```
</CodeGroup>