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

# Criando Webhooks

Este endpoint permite registrar um novo **webhook** para uma instância específica. Os webhooks são usados para receber notificações em tempo real sobre eventos importantes na instância, como mensagens recebidas ou mudanças de status.

**⚠️ Importante:** É obrigatório fornecer **ou** uma `url` **ou** um `webhook_id`. Se nenhum dos dois for informado, a requisição falhará.

### 🔍 Considerações

* Pelo menos um evento deve ser especificado na criação do webhook.
* Se uma `url` e um `webhook_id` forem fornecidos ao mesmo tempo, o `webhook_id` será priorizado.
* O webhook pode ser desativado posteriormente usando a propriedade `enabled`.


## OpenAPI

````yaml POST /wa/instances/{instance_id}/webhooks
openapi: 3.1.0
info:
  title: Zapster API
  description: ''
  version: 1.0.0
servers:
  - url: https://api.zapsterapi.com/v1
    description: Produção
security: []
tags: []
paths:
  /wa/instances/{instance_id}/webhooks:
    post:
      summary: Registra um novo webhook para a instância
      parameters:
        - name: instance_id
          in: path
          required: true
          schema:
            type: string
          description: Identificador único da instância.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - events
              properties:
                enabled:
                  type: boolean
                  description: 'Define se o webhook está ativado. Padrão: true.'
                  example: true
                events:
                  type: array
                  description: >-
                    Lista de eventos que acionam o webhook. Deve conter pelo
                    menos um evento.
                  items:
                    type: string
                    enum:
                      - group.created
                      - group.participants_added
                      - group.participants_demoted
                      - group.participants_promoted
                      - group.participants_removed
                      - group.updated
                      - instance.connected
                      - instance.disconnected
                      - instance.forbidden
                      - instance.mentioned
                      - instance.qrcode
                      - message.deleted
                      - message.delivered
                      - message.pinned
                      - message.reaction
                      - message.read
                      - message.received
                      - message.sent
                      - message.unpinned
                      - poll.created
                      - poll.deleted
                      - poll.updated
                  example:
                    - message.received
                name:
                  type: string
                  description: Nome do webhook configurado.
                  example: Meu Webhook
                test_mode:
                  type: boolean
                  description: 'Indica se o webhook está em modo de teste. Padrão: false.'
                  example: false
                test_url:
                  type: string
                  nullable: true
                  format: uri
                  description: URL de teste para validar o webhook, se aplicável.
                  example: null
                url:
                  type: string
                  format: uri
                  description: >-
                    URL para onde os eventos do webhook serão enviados.
                    Obrigatório caso `webhook_id` não seja fornecido.
                  example: https://webhook.example.com/receive
                webhook_id:
                  type: string
                  description: >-
                    ID de um webhook existente para ser reutilizado. Obrigatório
                    caso `url` não seja fornecida.
                  example: 2nenz69l0xbf0m3uu9tfo
      responses:
        '201':
          description: Webhook registrado com sucesso.
          content:
            application/json:
              schema:
                type: object
                description: Resposta ao registrar um webhook.
                properties:
                  created_at:
                    type: string
                    format: date-time
                    description: Data e hora de criação do webhook.
                    example: '2025-03-12T23:12:19.448Z'
                  enabled:
                    type: boolean
                    description: Indica se o webhook está ativado.
                    example: true
                  events:
                    type: array
                    description: Eventos configurados no webhook.
                    items:
                      type: string
                    example:
                      - message.received
                  id:
                    type: string
                    description: Identificador único do webhook.
                    example: 3nsnz68l0xbf0m3uu9tfo
                  name:
                    type: string
                    description: Nome do webhook configurado.
                    example: Meu Webhook
                  test_mode:
                    type: boolean
                    description: Indica se o webhook está em modo de teste.
                    example: false
                  test_url:
                    type: string
                    nullable: true
                    description: URL de teste configurada no webhook, se aplicável.
                    example: null
                  url:
                    type: string
                    format: uri
                    description: URL para onde os eventos do webhook serão enviados.
                    example: https://webhook.mydomain.com
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````