Webhooks

Troca a URL de um endpoint

Troca a URL do endpoint. A nova URL passa pela mesma verificação do cadastro (https, porta 443, IP público e HEAD respondendo 2xx).

Trocar a URL reativa o endpoint: o Status volta para active e ConsecutiveFailures volta para 0. O Secret não muda.

patch/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.

Request body

Urlstring required

URL de entrega, https na porta 443.

Example request

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

Response

URL alterada.

Changes

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