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

# Detalhar webhook de template

> Busque os dados de um webhook de template específico

export const EnterpriseText = ({lang = 'pt'}) => ({
  pt: <>Este endpoint requer a role <strong>ENTERPRISE</strong> na sua conta.</>,
  en: <>This endpoint requires the <strong>ENTERPRISE</strong> role on your account.</>,
  es: <>Este endpoint requiere el rol <strong>ENTERPRISE</strong> en tu cuenta.</>
})[lang];

## Conceituação

Retorna os dados de um webhook de template específico do tenant. Assim como na listagem, as credenciais de autenticação e o `secret` **não são retornados** por segurança.

<Note>
  <EnterpriseText lang="pt" />
</Note>

<Note>
  O `webhookId` é obtido no retorno do endpoint [Criar webhook de template](/webhooks/create-template-webhook) ou [Listar webhooks de template](/webhooks/list-template-webhooks).
</Note>


## OpenAPI

````yaml pt/webhooks/openapi-template.json GET /v1/webhooks/{webhookId}
openapi: 3.1.0
info:
  title: Omni Z-API - Webhooks de Template
  description: >-
    API para criar e gerenciar webhooks de template — endpoints que recebem os
    eventos de template do WhatsApp e não dependem de uma instância
    (`instanceId` gravado como `null`). Requer role ENTERPRISE. Convivem com as
    rotas de webhook por instância/canal, que permanecem inalteradas.
  version: 1.0.0
servers:
  - url: https://api.omni.z-api.io
security:
  - bearerAuth: []
paths:
  /v1/webhooks/{webhookId}:
    get:
      tags:
        - Webhooks de template
      summary: Detalhar webhook de template
      description: >-
        Retorna os dados de um webhook de template específico do tenant.
        Credenciais e `secret` não são retornados.
      operationId: getTemplateWebhook
      parameters:
        - name: webhookId
          in: path
          required: true
          description: ID do webhook de template
          schema:
            type: string
            example: 8F2C00000000000000000000000000A1
      responses:
        '200':
          description: Dados do webhook de template
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateWebhookResponse'
              example:
                id: 8F2C00000000000000000000000000A1
                channelId: null
                instanceId: null
                url: https://destino/webhook
                description: Webhook de template
                events:
                  - UPDATE_TEMPLATE_STATUS
                status: ENABLED
                signing: false
                auth:
                  type: NONE
                  configured: false
                payloadFormat: DEFAULT
                customAttributes: {}
                createdAt: '2026-07-15T19:00:00.000+00:00'
                updatedAt: '2026-07-15T19:00:00.000+00:00'
        '404':
          description: Webhook não encontrado para o tenant
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Webhook not found
        '422':
          description: Conta sem role ENTERPRISE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: This action requires ENTERPRISE role
components:
  schemas:
    TemplateWebhookResponse:
      type: object
      properties:
        id:
          type: string
          description: ID único do webhook de template
          example: 8F2C00000000000000000000000000A1
        channelId:
          type: string
          nullable: true
          description: Sempre `null` para webhooks de template
          example: null
        instanceId:
          type: string
          nullable: true
          deprecated: true
          description: Descontinuado e sempre `null` para webhooks de template
          example: null
        url:
          type: string
          description: URL de destino dos eventos
          example: https://destino/webhook
        description:
          type: string
          nullable: true
          description: Descrição do webhook
          example: Webhook de template
        events:
          type: array
          description: Eventos de template configurados
          items:
            $ref: '#/components/schemas/TemplateEvent'
          example:
            - UPDATE_TEMPLATE_STATUS
            - UPDATE_TEMPLATE_CATEGORY
        status:
          type: string
          enum:
            - ENABLED
            - DISABLED
          description: Status atual do webhook
          example: ENABLED
        signing:
          type: boolean
          description: Indica se a assinatura HMAC está habilitada
          example: false
        auth:
          $ref: '#/components/schemas/WebhookAuthInfo'
        payloadFormat:
          type: string
          enum:
            - DEFAULT
          description: Sempre `DEFAULT` para webhooks de template
          example: DEFAULT
        customAttributes:
          type: object
          additionalProperties: true
          example: {}
        createdAt:
          type: string
          format: date-time
          example: '2026-07-15T19:00:00.000+00:00'
        updatedAt:
          type: string
          format: date-time
          example: '2026-07-15T19:00:00.000+00:00'
    Error:
      type: object
      properties:
        error:
          type: string
    TemplateEvent:
      type: string
      enum:
        - UPDATE_TEMPLATE_STATUS
        - UPDATE_TEMPLATE_CATEGORY
      description: >-
        Eventos de template aceitos: `UPDATE_TEMPLATE_STATUS` (atualização de
        status do template — aprovado/rejeitado etc.) e
        `UPDATE_TEMPLATE_CATEGORY` (atualização de categoria do template).
    WebhookAuthInfo:
      type: object
      description: >-
        Resumo da autenticação configurada — credenciais não são retornadas por
        segurança
      properties:
        type:
          type: string
          enum:
            - NONE
            - BEARER
            - API_KEY
            - BASIC
            - CUSTOM_HEADER
          example: NONE
        configured:
          type: boolean
          description: '`true` quando credenciais estão configuradas'
          example: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Secret Key gerada no painel de Segurança do Omni Z-API

````