Webhook - Get Validation Events

  • Referência
Serviço:
Partner Center Rest
Versão da API:
v1

Recupera o status de um webhook de teste dado o correlationId

GET https://api.partnercenter.microsoft.com/webhooks/v{version}/registration/validationEvents/{correlationId}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
correlationId
 path True

string

CorrelationId retornado do método de teste original
version
 path True

string

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Token de autenticação do portador
ms-correlationid

string

Um identificador exclusivo para a chamada, útil em logs e rastreamentos de rede para solucionar problemas de erros. O valor deve ser redefinido para cada chamada. Todas as operações devem incluir esse cabeçalho.
ms-requestid

string

Um identificador exclusivo para a chamada, usado para garantir a idempotência. No caso de um tempo limite, a chamada de repetição deve incluir o mesmo valor. Após receber uma resposta (êxito ou falha nos negócios), o valor deve ser redefinido para a próxima chamada.

Respostas

Nome Tipo Description
200 OK

WebhookValidationEvent

OKEY

Media Types: "application/json", "text/json"
400 Bad Request

Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro.

Media Types: "application/json", "text/json"
401 Unauthorized

A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro.

Media Types: "application/json", "text/json"
403 Forbidden

A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la.

Media Types: "application/json", "text/json"
404 Not Found

O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados.

Media Types: "application/json", "text/json"
500 Internal Server Error

O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem repetir isso.

Media Types: "application/json", "text/json"

Segurança

Authorization

Token de autenticação do portador

Tipo: apiKey
Em: header

Definições

Nome Description
WebhookResponse
WebhookValidationEvent

WebhookResponse

Objeto
Nome Tipo Description
dateTimeUtc

string (date-time)

responseCode

string

responseMessage

string

systemError

boolean

WebhookValidationEvent

Objeto
Nome Tipo Description
callbackUrl

string

correlationId

string

partnerId

string

results

WebhookResponse[]

status

string