Consulta um evento de webhook + as entregas dele
/v1/webhooks/events/{eventId}Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros do caminho
eventIdstringobrigatórioIdentificador público (wbh_…)
Respostas
200Sucesso
idstringobrigatórioIdentificador público (wbh_…)
dataanyO conteúdo do evento, como enviado à sua URL.
typestringobrigatórioTipo do evento, no formato
recurso.acao._linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).sourcestringobrigatórioOrigem do evento na plataforma.
attemptsintegerobrigatórioTentativas de entrega feitas, somando todos os endpoints.
merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
resourcestringobrigatórioO recurso de que o evento trata (ex.:
transaction).createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
deliveredbooleanobrigatórioSe todos os endpoints assinantes receberam a entrega com sucesso.
dispatchesobject[]As entregas deste evento, uma por endpoint (só na leitura individual).
+14 campos de
dispatchesidstringobrigatórioIdentificador público (wdi_…)
statusstringobrigatóriopending,success,failed,retryingoucanceled.Valores:pendingsuccessfailedretryingcanceledeventIdstringobrigatóriopode ser nuloO evento entregue;
nullnuma entrega sintética (ping de teste).attemptsintegerobrigatórioTentativas feitas até agora.
endpointstringobrigatórioA URL para onde foi entregue.
createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
eventTypestringobrigatóriopode ser nuloTipo do evento entregue (ex.:
transaction.approved);nullnuma entrega sintética.successAtstringobrigatóriopode ser nuloQuando a entrega deu certo;
nullaté lá.endpointIdstringobrigatóriopode ser nuloO endpoint para onde foi entregue.
responseBodystringobrigatóriopode ser nuloCorpo que o seu endpoint respondeu (primeiros 8 KB);
nullquando não houve.responseTimeintegerobrigatóriopode ser nuloQuanto tempo o seu endpoint levou para responder, em milissegundos.
lastAttemptAtstringobrigatóriopode ser nuloQuando a última tentativa foi feita.
nextAttemptAtstringobrigatóriopode ser nuloQuando a próxima tentativa está marcada;
nullquando não há.responseStatusCodeintegerobrigatóriopode ser nuloStatus HTTP que o seu endpoint respondeu;
nullquando não respondeu.
resourceIdstringobrigatóriopode ser nuloId público desse recurso.
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório