Documentação Técnica

Obter Metadado

Para monitorar o andamento de chamadas assíncronas, os clientes podem verificar o status de uma requisição utilizando o QueryId obtido na chamada original. Este método informa se a consulta ainda está em execução ou se ocorreu alguma falha, retornando um objeto que descreve o status atual da requisição e o tempo decorrido em cada etapa do processo.

Parâmetros de Entrada

A tabela abaixo detalha os campos aceitos na consulta a este serviço.

CampoDescrição
QueryIdID retornado pela criação do hook / requisição assíncrona

Retorno

A tabela a seguir descreve os campos do objeto de retorno deste método.

CampoDescriçãoValores Possíveis
HookMetadata.StatusO status atual da requisição assíncrona associadaRegistrationFailed, Registered, Dispatched, DispatchmentFailed, Posted, PostFailed
HookMetadata.RegistrationElapsedTimeO tempo decorrido na etapa de registroTempo em milisegundos
HookMetadata.DispatchmentElapsedTimeO tempo decorrido na etapa de despachoTempo em milisegundos
HookMetadata.ClientResponseHttpCodeCódigo HTTP da resposta do webhookNúmero
HookMetadata.ClientResponseHttpDescriptionDescrição do código HTTP da resposta do webhookTexto
HookMetadata.ClientResponseContentResposta bruta do webhookTexto
HookMetadata.DeliveryHistoryHistórico de tentativas de envio para uma dada requisiçãoLista de objetos
Language
Credentials
Click Try It! to start a request and see the response here!