Webhooks

Lista os tipos de documento e de evento aceitos

Lista os valores aceitos em DocumentType e EventType no cadastro de subscription. Todo tipo de documento aceita todos os eventos.

get/v1/webhooks/metadata

Request

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

Response

Valores aceitos.

DocumentTypesstring[]

Tipos de documento aceitos em DocumentType.

EventTypesstring[]

Eventos aceitos em EventType.

Example response

{
  "DocumentTypes": [
    "nfe"
  ],
  "EventTypes": [
    "document.received",
    "document.canceled"
  ]
}

Changes

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