Webhooks

Cadastra a URL que vai receber as notificações de webhook

Cadastra um endpoint de entrega. Antes de salvar, a Qive verifica a URL:

  • só https, na porta 443, resolvendo para um IP público;
  • é feito um HEAD na URL com o header X-Qive-Webhook: Qive-Webhooks/1.0, com tempo limite de 5 segundos, e a resposta precisa ser 2xx;
  • redirecionamentos não são seguidos: cadastre o endereço final.

O Secret só é devolvido nesta resposta. Guarde-o: ele não pode ser consultado depois.

A mesma URL não pode ser cadastrada duas vezes na mesma conta.

post/v1/webhooks/endpoints

Request

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

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.

Request body

Urlstring required

URL de entrega, https na porta 443.

Example request

{
  "Url": "https://erp.exemplo.com.br/webhooks/qive"
}

Response

Endpoint cadastrado. Única resposta que contém o Secret.

Idstring uuid

Identificador do endpoint.

Secretstring

Segredo do endpoint, prefixado com whsec_. Devolvido só no cadastro.

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.

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",
  "Secret": "whsec_4f9a1c2e7b3d8a6f0e5c9b2a1d7e3f8c6b0a9d4e2f7c1b8a3e6d0f5c9a2b7e4d",
  "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.