---
title: "Visualizar webhook"
method: GET
path: "/{alias}/webhooks/{id}"
tags: ["Webhooks"]
---

# Visualizar webhook

`GET /{alias}/webhooks/{id}`

## Request

- Base URL: `https://api.dooki.com.br/v2`
- URL: `https://api.dooki.com.br/v2/{alias}/webhooks/{id}`
- Auth: API key in header `User-Token` and API key in header `User-Secret-Key`

Visualiza os detalhes de um webhook específico

## Path parameters

- `alias` string, required
- `id` integer, required

## Response `200`

Detalhes do webhook

- object: Recursos adicionais do webhook, retornados sob demanda via parâmetro `include`.
  - `id` integer: ID do webhook.
  - `active` boolean: Indica se o webhook está ativo e recebendo os eventos assinados.
  - `name` string: Nome do webhook
  - `url` string, uri: URL para onde os eventos serão enviados
  - `secret_key` string: Chave secreta de 40 caracteres usada para gerar a assinatura HMAC enviada nas requisições do webhook, permitindo validar a origem do evento.
  - `events` object: Eventos assinados pelo webhook.
    - `data` object[]: Lista dos eventos que disparam o webhook.
      - `name` string: Nome do evento que dispara o webhook (ex.: `order.created`).
      - `description` string: Descrição do que dispara o evento.
  - `products` object: Produtos aos quais o webhook está restrito.
    - `data` ProductWithRelations[]: Lista dos produtos aos quais o webhook está restrito.
      - `id` integer: Identificador único do produto.
      - `merchant_id` integer: ID da loja dona do produto.
      - `seller_id` integer, nullable: ID do vendedor (marketplace/multi-seller) responsável pelo produto, quando aplicável.
      - `affiliation_id` integer, nullable: ID da afiliação de pagamento (adquirente/gateway) vinculada ao produto.
      - `erp_id` integer: ID do produto no ERP integrado à loja, quando houver integração.
      - `relevance` integer, nullable: Nível de prioridade do produto na busca (1 = padrão, 2 = média, 3 = alta), definido pelo campo `priority` na requisição.
      - `active` boolean: Indica se o produto está ativo e disponível para venda.
      - `gift_value` string: Valor cobrado pela embalagem de presente do produto, quando aplicável.
      - `searchable` boolean: Indica se o produto pode ser encontrado na busca da loja.
      - `simple` boolean: Indica se o produto é simples, sem variações.
      - `ncm` string: Código NCM (Nomenclatura Comum do Mercosul) do produto, usado para classificação fiscal em notas fiscais.
      - `has_variations` boolean: Indica se o produto possui variações (ex.: cor, tamanho).
      - `is_digital` boolean: Indica se o produto é digital (sem envio físico).
      - `warranty` integer, nullable: Prazo de garantia do produto, em meses.
      - `custom_shipping` boolean: Indica se o produto usa frete customizado, em vez do frete padrão da loja.
      - `shipping_price` string: Valor de frete fixo configurado para o produto, quando `custom_shipping` for verdadeiro.
      - `name` string: Nome do produto.
      - `slug` string: Slug do produto, usado na URL da página do produto.
      - `sku` string: Código do SKU principal do produto.
      - `rating` integer: Nota média de avaliação do produto.
      - `priority` integer: Prioridade de exibição do produto usada na ordenação manual de listagens.
      - `url` string, url: URL completa da página do produto na loja.
      - `redirect_url_card` string, nullable: URL de redirecionamento configurada para compra do produto via cartão.
      - `redirect_url_billet` string, nullable: URL de redirecionamento configurada para compra do produto via boleto.
      - `preview_url` string, url: URL para pré-visualizar o produto antes da publicação.
  - `disabled_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
    - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer: Número de representação do timezone.
    - `timezone` string: Fuso horário associado.
  - `created_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
    - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer: Número de representação do timezone.
    - `timezone` string: Fuso horário associado.
  - `updated_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
    - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer: Número de representação do timezone.
    - `timezone` string: Fuso horário associado.

## Other responses

- `404`: Webhook não encontrado

## Changes

- **2026-11-03** `bbafb577e11c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yampi/apis/yampi-api/changes/:alias/webhooks/:id/get.md)

---

[API](https://skmtc.dev/yampi/apis/yampi-api.md) - [All operations](https://skmtc.dev/yampi/apis/yampi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yampi/apis/yampi-api/revisions/74739ec8876f?raw)