Webhooks

Consulta um endpoint pelo Id

Devolve o endpoint e o estado de entrega dele. O Secret não é devolvido.

get/v1/webhooks/endpoints/{id}

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/webhooks/endpoints/{id}
  • Auth: none declared. Required headers: X-Api-Id, X-Api-Key, X-Use-ApiGateway

Path parameters

idstring uuid required

Identificador (UUID) do recurso, devolvido no cadastro.

Headers

X-Api-Idstring required

API ID usado para autenticação.

X-Api-Keystring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Response

Endpoint encontrado.

Idstring uuid

Identificador do endpoint.

Urlstring

URL de entrega, https na porta 443.

Status'active' | 'unreachable'

Estado de entrega do endpoint. active: recebe notificações. unreachable: desativado após falhas consecutivas; reative com POST /v1/webhooks/endpoints/{id}/reactivate.

ConsecutiveFailuresinteger

Quantidade de falhas de entrega consecutivas. Volta a 0 numa entrega bem-sucedida.

LastFailureAtstring date-time nullable

Data e hora (RFC 3339, UTC) da última falha de entrega. null se nunca falhou.

LastStatusCodeinteger nullable

Status HTTP recebido na última falha de entrega. null se nunca falhou ou se a falha não teve resposta HTTP.

VerifiedAtstring date-time

Data e hora (RFC 3339, UTC) da última verificação da URL.

CreatedAtstring date-time

Data e hora (RFC 3339, UTC) do cadastro.

UpdatedAtstring date-time

Data e hora (RFC 3339, UTC) da última alteração.

Example response

{
  "Id": "0b9f6e2a-3c41-4d8e-9a57-2f1c6d8e4b10",
  "Url": "https://erp.exemplo.com.br/webhooks/qive",
  "Status": "active",
  "VerifiedAt": "2026-10-05T12:00:00Z",
  "CreatedAt": "2026-10-05T12:00:00Z",
  "UpdatedAt": "2026-10-05T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.