DesenvolvedoresReferência da APIWebhooks

Consultar endpoint de webhook

GET
/webhook-endpoints/{endpointId}

Configuração e saúde do endpoint: falhas seguidas, últimos envios com sucesso e com falha e o motivo da desativação, quando houver.

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

Escopo: webhooks:read.

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 resposta

Sucesso.

application/json
  1. response
data*
meta*
curl -X GET 'https://minepag.com.br/api/v1/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "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"  }}

Criar endpoint de webhook POST

Página anterior

Alterar endpoint de webhook PATCH

Próxima página