# Consultar webhook e entrega por ID

`GET /v1/instances/{id}/webhook`

Sem cadastro: registered=false, webhooks=[]. Com cadastro inclui webhooks=[registro] e deliveryStatus. Nunca revela o secret.

## Autenticação

Header obrigatório: `admintoken`. Use o token administrativo do servidor.

Base URL: a API do servidor selecionado, como `https://1.atendro.cloud`. O domínio `wpp.atendro.cloud` hospeda a documentação e o console.

## Parâmetros de caminho

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `id` | `string` | obrigatório | Identificador devolvido pela API. Comprimento mínimo: `1`. Formato: `uuid` |

## Headers adicionais

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `X-Request-Id` | `string` | opcional | ASCII visível sem espaços, 1–128 caracteres. Inválido/ausente é substituído por UUID. Ecoado na resposta. Comprimento máximo: `128` |

## Corpo da requisição

Não há corpo de requisição definido para esta operação.

## Resposta 200

Consultar webhook e entrega

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `registered` | `boolean` | obrigatório | — |
| `id` | `string` | opcional | Formato: `uuid` |
| `url` | `string` | opcional | — |
| `events` | `array<string>` | opcional | — |
| `enabled` | `boolean` | opcional | — |
| `excludeMessages` | `array / null` | opcional | — |
| `hasSecret` | `boolean` | opcional | — |
| `secretSealed` | `boolean` | opcional | — |
| `createdAt` | `string` | opcional | RFC 3339. Formato: `date-time` |
| `updatedAt` | `string` | opcional | RFC 3339. Formato: `date-time` |
| `deliveryStatus` | `object` | opcional |  Modelo: [DeliveryStatus](https://wpp.atendro.cloud/docs/modelos/delivery-status.md). |
| `ignoredEvents` | `array<string>` | opcional | — |
| `webhooks` | `array<object>` | opcional | — |
| `inheritedGlobal` | `boolean` | opcional | Indica que a inscrição segue o webhook global do servidor. |

Exemplo ilustrativo, com valores sintéticos:

```json
{
  "registered": true,
  "url": "https://seu-atendro.example/webhooks/atendrozap",
  "events": [
    "connection",
    "messages"
  ],
  "enabled": true,
  "hasSecret": true,
  "inheritedGlobal": true
}
```

## Resposta 401

unauthorized: header ausente, inválido ou duplicado. Bearer/query/instancekey não substituem admintoken/token.

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `error` | `string` | obrigatório | — |
| `message` | `string` | opcional | — |
| `messageid` | `string` | opcional | ID para reconciliação quando o resultado é ambíguo. |
| `messageId` | `string` | opcional | — |
| `id` | `string` | opcional | — |
| `provider_code` | `integer` | opcional | — |
| `error_key` | `string` | opcional | — |
| `error_source` | `string` | opcional | — |
| `details` | `object` | opcional | — |
| `instance` | `object` | opcional |  Modelo: [Instance](https://wpp.atendro.cloud/docs/modelos/instance.md). |

Exemplo ilustrativo, com valores sintéticos:

```json
{
  "error": "unauthorized"
}
```

## Resposta 404

instance_not_found.

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `error` | `string` | obrigatório | — |
| `message` | `string` | opcional | — |
| `messageid` | `string` | opcional | ID para reconciliação quando o resultado é ambíguo. |
| `messageId` | `string` | opcional | — |
| `id` | `string` | opcional | — |
| `provider_code` | `integer` | opcional | — |
| `error_key` | `string` | opcional | — |
| `error_source` | `string` | opcional | — |
| `details` | `object` | opcional | — |
| `instance` | `object` | opcional |  Modelo: [Instance](https://wpp.atendro.cloud/docs/modelos/instance.md). |

## Resposta 502

storage_unavailable (Retry-After=5). Algumas rotas também retornam 502 por falha da conexão/mídia; consultar error.

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `error` | `string` | obrigatório | — |
| `message` | `string` | opcional | — |
| `messageid` | `string` | opcional | ID para reconciliação quando o resultado é ambíguo. |
| `messageId` | `string` | opcional | — |
| `id` | `string` | opcional | — |
| `provider_code` | `integer` | opcional | — |
| `error_key` | `string` | opcional | — |
| `error_source` | `string` | opcional | — |
| `details` | `object` | opcional | — |
| `instance` | `object` | opcional |  Modelo: [Instance](https://wpp.atendro.cloud/docs/modelos/instance.md). |

Exemplo ilustrativo, com valores sintéticos:

```json
{
  "error": "storage_unavailable"
}
```

## Resposta default

Falha; usar HTTP status e error. 404 rota inexistente; 405 método inválido com Allow. Ver catálogo no guia de integração.

| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| `error` | `string` | obrigatório | — |
| `message` | `string` | opcional | — |
| `messageid` | `string` | opcional | ID para reconciliação quando o resultado é ambíguo. |
| `messageId` | `string` | opcional | — |
| `id` | `string` | opcional | — |
| `provider_code` | `integer` | opcional | — |
| `error_key` | `string` | opcional | — |
| `error_source` | `string` | opcional | — |
| `details` | `object` | opcional | — |
| `instance` | `object` | opcional |  Modelo: [Instance](https://wpp.atendro.cloud/docs/modelos/instance.md). |

## Exemplos de requisição

Defina as variáveis no ambiente privado e substitua os dados sintéticos antes de usar. Os exemplos não executam operações nesta página.

### cURL

```sh
curl --request GET "$ATENDROZAP_URL/v1/instances/${ID}/webhook" \
  --header "admintoken: $ATENDROZAP_ADMIN_TOKEN"
```

### JavaScript

```javascript
const baseUrl = process.env.ATENDROZAP_URL;
let path = "/v1/instances/{id}/webhook";
path = path.replace("{id}", encodeURIComponent(process.env.ID));
const url = new URL(path, baseUrl);

const response = await fetch(url, {
  method: "GET",
  headers: {
    "admintoken": process.env.ATENDROZAP_ADMIN_TOKEN
  },
});

if (!response.ok) {
  throw new Error(`AtendroZAP: HTTP ${response.status}`);
}
const result = await response.json();
```

## Relacionados

- [Webhooks e eventos](https://wpp.atendro.cloud/docs/api/webhooks.md)
- [Autenticação](https://wpp.atendro.cloud/docs/guias/autenticacao.md)
- [Erros e idempotência](https://wpp.atendro.cloud/docs/guias/erros-e-idempotencia.md)