DesenvolvedoresReferência da APIWebhooks

Listar endpoints de webhook

GET
/webhook-endpoints

Endpoints de webhook e de serviço externo da loja, do mais recente para o mais antigo. O segredo de assinatura nunca aparece aqui.

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 consulta

limit?integer

Itens por página (1 a 100).

Intervalo1 <= value <= 100
Padrão20
cursor?string

Valor de meta.pagination.nextCursor da página anterior.

Tamanholength <= 200
status?string
Value in"enabled""disabled""failing"

Corpo da resposta

Sucesso.

application/json
  1. response
data*array<>
meta*
curl -X GET 'https://minepag.com.br/api/v1/webhook-endpoints'
{  "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",    "pagination": {      "limit": -9007199254740991,      "hasMore": true,      "nextCursor": "string"    }  }}