Verificar processo HTTP

Sem autenticação; não atesta banco nem WhatsApp.

Autenticação

Endpoint público, sem token.

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.

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.

Respostas

Verificar processo HTTP

Campo	Tipo	Presença	Descrição
`status`	`string`	obrigatório	Valores: `"alive"`, `"ready"`, `"not_ready"`
`reason`	`string`	opcional	Valores: `"database_unreachable"`

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.

Requisição

cURL

curl --request GET "$ATENDROZAP_URL/health/live"

JavaScript

const baseUrl = process.env.ATENDROZAP_URL;
let path = "/health/live";
const url = new URL(path, baseUrl);

const response = await fetch(url, {
  method: "GET",
});

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

Use a URL e o token do servidor cadastrado. Os dados destes exemplos são fictícios.

Resposta 200

JSON · exemplo ilustrativo

{
  "status": "alive"
}