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

# Criar webhook

> Cria um webhook inscrito em UM número de WhatsApp. O número vem do escopo da key (key de número), do cabeçalho x-whatsapp-number-id ou do campo whatsappNumberId no body — se o body contradisser o escopo da key → 400 NUMBER_MISMATCH; sem número resolvível → 400 NUMBER_REQUIRED; número de outro tenant → 404 NUMBER_NOT_FOUND. events escolhe o que será entregue: lista vazia/omitida NÃO dispara nada (não há "assinar tudo" implícito; use "*" para todos) e eventos que o provedor do número não emite são descartados silenciosamente. O segredo de assinatura NUNCA é retornado.



## OpenAPI

````yaml openapi.pt.json POST /v1/webhooks
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Criar webhook
      description: >-
        Cria um webhook inscrito em UM número de WhatsApp. O número vem do
        escopo da key (key de número), do cabeçalho x-whatsapp-number-id ou do
        campo whatsappNumberId no body — se o body contradisser o escopo da key
        → 400 NUMBER_MISMATCH; sem número resolvível → 400 NUMBER_REQUIRED;
        número de outro tenant → 404 NUMBER_NOT_FOUND. events escolhe o que será
        entregue: lista vazia/omitida NÃO dispara nada (não há "assinar tudo"
        implícito; use "*" para todos) e eventos que o provedor do número não
        emite são descartados silenciosamente. O segredo de assinatura NUNCA é
        retornado.
      operationId: post_webhooks
      parameters:
        - name: x-whatsapp-number-id
          in: header
          required: false
          description: >-
            Restringe ao contexto de um número (obrigatório em concessões OAuth
            por número).
          schema:
            type: string
          example: num_01HZX...
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Endpoint HTTPS que receberá os eventos.
                  example: https://hooks.acme.com/whatsapp
                name:
                  type: string
                  description: 'Nome de exibição (padrão: hostname da URL).'
                  example: n8n
                events:
                  type: array
                  items:
                    type: string
                  description: >-
                    Eventos a assinar (ex.: ["message.received"]); "*" = todos.
                    Vazio/omitido = não dispara nada.
                  example: '["message.received", "message.delivered"]'
                whatsappNumberId:
                  type: string
                  description: >-
                    Número alvo — necessário só com key de tenant sem cabeçalho
                    de número; com key de número deve coincidir com o escopo
                    (400 NUMBER_MISMATCH).
                  example: num_01HZX...
              required:
                - url
            example:
              url: https://hooks.acme.com/whatsapp
              name: n8n
              events:
                - message.received
      responses:
        '201':
          description: Criar webhook
          content:
            application/json:
              example:
                id: wh_01HZX...
                tenantId: tenant_01HZX...
                name: n8n
                url: https://hooks.acme.com/whatsapp
                environment: LIVE
                active: true
                events:
                  - message.received
                createdAt: '2026-07-03T12:00:00.000Z'
                updatedAt: '2026-07-03T12:00:00.000Z'
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````