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

# Editar webhook

> Altera a URL, os eventos ou a situação do webhook. Envie apenas os campos que mudam; use `enabled` para ativar ou desativar.

Os valores aceitos em `events` estão em [Criar webhook](https://developers.datafyapi.com.br/api-reference/administracao/criar-webhook.md#eventos-disponíveis).

## Resposta

| Campo | Descrição |
| - | - |
| `id` | ID do webhook |
| `url` | URL que recebe os eventos |
| `events` | [Eventos](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/receber-eventos.md) que o webhook recebe |
| `enabled` | Indica se o webhook está ativo |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json PATCH /channels/whatsapp/{id}/webhooks/{webhookId}
openapi: 3.1.0
info:
  title: Datafy API — Administração de canais
  version: 1.0.0
servers:
  - url: https://cloud.datafyapi.com.br
    description: Produção
security:
  - tokenDeConta: []
paths:
  /channels/whatsapp/{id}/webhooks/{webhookId}:
    patch:
      summary: Editar webhook
      description: >-
        Altera a URL, os eventos ou a situação do webhook. Envie apenas os
        campos que mudam; use `enabled` para ativar ou desativar.
      operationId: editarWebhook
      parameters:
        - $ref: '#/components/parameters/CanalId'
        - $ref: '#/components/parameters/WebhookId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  example: https://exemplo.com/webhook
                  description: URL que recebe os eventos. Precisa usar HTTPS.
                events:
                  type: array
                  items:
                    type: string
                    enum:
                      - messages
                      - smb_message_echoes
                      - message_template_status_update
                      - message_template_quality_update
                      - message_template_components_update
                      - account_alerts
                      - account_update
                      - account_review_update
                      - account_settings_update
                      - phone_number_name_update
                      - phone_number_quality_update
                      - business_capability_update
                      - business_status_update
                      - template_category_update
                      - template_correct_category_detection
                      - flows
                      - calls
                      - security
                      - automatic_events
                      - tracking_events
                      - history
                      - smb_app_state_sync
                      - payment_configuration_update
                      - partner_solutions
                      - group_lifecycle_update
                      - group_participants_update
                      - group_settings_update
                      - group_status_update
                      - user_preferences
                  example:
                    - messages
                  description: Eventos que o webhook recebe. Não pode ser uma lista vazia.
                enabled:
                  type: boolean
                  example: true
                  default: true
                  description: Ativa ou desativa o webhook.
            example:
              enabled: false
      responses:
        '200':
          description: Webhook editado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResposta'
              example:
                id: 9d8c7b6a-5f4e-4d3c-2b1a-0f9e8d7c6b5a
                url: https://exemplo.com/webhook
                events:
                  - messages
                enabled: true
        '400':
          description: Dados inválidos.
          content:
            application/json:
              examples:
                sem_campos:
                  summary: Nenhum campo enviado
                  value:
                    statusCode: 400
                    message: Envie url, events e/ou enabled para editar
                url_invalida:
                  summary: URL sem HTTPS
                  value:
                    statusCode: 400
                    message: URL inválida — precisa ser https://…
                events_nao_lista:
                  summary: events não é uma lista
                  value:
                    statusCode: 400
                    message: events deve ser uma lista de eventos
                events_vazio:
                  summary: events vazio
                  value:
                    statusCode: 400
                    message: >-
                      O webhook precisa de ao menos um evento (sem evento ele
                      nunca dispara)
                evento_inexistente:
                  summary: Evento inexistente
                  value:
                    statusCode: 400
                    message: 'Evento(s) inválido(s): mesages'
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
        '404':
          description: Canal ou webhook não encontrado.
          content:
            application/json:
              examples:
                canal:
                  summary: Canal não encontrado
                  value:
                    statusCode: 404
                    message: Canal não encontrado
                webhook:
                  summary: Webhook não encontrado
                  value:
                    statusCode: 404
                    message: Webhook não encontrado
components:
  parameters:
    CanalId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do canal, retornado em Listar canais e em Criar canal.
    WebhookId:
      name: webhookId
      in: path
      required: true
      schema:
        type: string
      description: ID do webhook, retornado em Listar webhooks e em Criar webhook.
  schemas:
    WebhookResposta:
      type: object
      properties:
        id:
          type: string
          description: ID do webhook.
        url:
          type: string
          description: URL que recebe os eventos.
        events:
          type: array
          items:
            type: string
          description: Eventos que o webhook recebe.
        enabled:
          type: boolean
          description: Indica se o webhook está ativo.
  responses:
    NaoAutorizado:
      description: Token de conta ausente ou inválido.
      content:
        application/json:
          example:
            statusCode: 401
            message: Token de conta ausente ou inválido
    AssinaturaInativa:
      description: A assinatura da conta não está ativa.
      content:
        application/json:
          example:
            statusCode: 403
            message: >-
              Sua assinatura precisa estar ativa para usar a API. Acesse o
              painel para ativá-la.
  securitySchemes:
    tokenDeConta:
      type: http
      scheme: bearer
      description: >-
        Token de conta gerado no painel da Datafy, em Perfil. Formato:
        `sk_acct_xxx`. Diferente do token de canal (`sk_live_`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.