Webhooks

Liga um endpoint a um CNPJ/CPF, tipo de documento e evento

Cria uma subscription: os documentos do Owner informado, do tipo DocumentType, passam a gerar notificações do evento EventType no endpoint EndpointId.

  • Owner precisa estar entre os CNPJs/CPFs autorizados para as credenciais utilizadas; caso contrário, retorna 403.
  • Os valores aceitos de DocumentType e EventType estão em GET /v1/webhooks/metadata.
  • Só existe uma subscription por combinação de Owner, DocumentType e EventType na conta, independentemente do endpoint.
post/v1/webhooks/subscriptions

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/webhooks/subscriptions
  • 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

Ownerstring required

CNPJ (14 caracteres, aceita o formato alfanumérico) ou CPF (11 dígitos) dos documentos notificados, sem pontuação. Precisa estar entre os autorizados para as credenciais utilizadas.

DocumentType'nfe' required

Tipo de documento fiscal. Valores aceitos em GET /v1/webhooks/metadata.

EventType'document.received' | 'document.canceled' required

Evento notificado. document.received: documento recebido. document.canceled: documento cancelado.

EndpointIdstring uuid required

Identificador do endpoint que recebe as notificações.

Example request

{
  "Owner": "19427033000140",
  "DocumentType": "nfe",
  "EventType": "document.received",
  "EndpointId": "0b9f6e2a-3c41-4d8e-9a57-2f1c6d8e4b10"
}

Response

Subscription criada.

Idstring uuid

Identificador da subscription.

Ownerstring

CNPJ (14 caracteres, aceita o formato alfanumérico) ou CPF (11 dígitos) dos documentos notificados, sem pontuação. Precisa estar entre os autorizados para as credenciais utilizadas.

DocumentType'nfe'

Tipo de documento fiscal. Valores aceitos em GET /v1/webhooks/metadata.

EventType'document.received' | 'document.canceled'

Evento notificado. document.received: documento recebido. document.canceled: documento cancelado.

EndpointIdstring uuid

Identificador do endpoint que recebe as notificações.

Activeboolean

Indica se a subscription está ativa.

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": "7c2d1e4f-5a6b-4c3d-8e9f-0a1b2c3d4e5f",
  "Owner": "19427033000140",
  "DocumentType": "nfe",
  "EventType": "document.received",
  "EndpointId": "0b9f6e2a-3c41-4d8e-9a57-2f1c6d8e4b10",
  "Active": true,
  "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.