DesenvolvedoresReferência da APIWebhooks

Alterar endpoint de webhook

PATCH
/webhook-endpoints/{endpointId}

Altera só os campos enviados. enabled: false pausa os envios; enabled: true reativa o endpoint e zera as falhas seguidas.

Chave: Só chave secreta (chamada pelo servidor).

Escopo: webhooks:write.

Limite: 60 requisições a cada 1 h, além do limite geral de 600 por minuto por chave.

Autorização

chaveSecreta
headerAutorizaçãoBearer <chave de API>

Chave secreta (sk_…). Use só no servidor; requisições de navegador (com Origin) são recusadas.

Parâmetros de caminho

endpointId*string
Formatouuid

Corpo da requisição

application/json
  1. body
url?string
Tamanholength <= 2048
description?|null
kind?string
Value in"generic""fulfillment_service"
eventTypes?array<>
Itens1 <= items
enabled?boolean

false pausa os envios; true reativa o endpoint e zera as falhas seguidas.

Corpo da resposta

Sucesso.

application/json
  1. response
data*
meta*
curl -X PATCH 'https://minepag.com.br/api/v1/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "kind": "generic",    "status": "enabled",    "url": "string",    "description": "string",    "eventTypes": [      "order.created"    ],    "consecutiveFailures": -9007199254740991,    "lastSucceededAt": "2019-08-24T14:15:22Z",    "lastFailedAt": "2019-08-24T14:15:22Z",    "disabledReason": "string",    "previousSecretExpiresAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "meta": {    "requestId": "string"  }}