Autenticação: token JWT ou chave de API do vendedor. Consulte Autenticação.
url informada sempre que um evento cujo nome apareça (como substring, sem diferenciar maiúsculas e minúsculas) dentro da string events for emitido pela plataforma. A semântica completa de despacho e retentativas está documentada em Webhooks e Jobs.
Parâmetros de caminho
Vendedor ao qual este webhook pertence. Deve referenciar um vendedor existente; caso contrário a requisição é rejeitada com
400 e mensagem "Seller not found.".Corpo
URL de destino. Pode ser fornecida sem esquema — o despachante adiciona
https:// caso http:// ou https:// não estejam presentes.Segredo compartilhado. Ele é enviado de volta ao seu endpoint dentro do payload JSON (
"secret": "<valor>") para que seu handler verifique que a chamada vem da plataforma. Trate-o como uma senha: a API nunca retorna este valor em GETs posteriores, portanto armazene-o do seu lado no momento da criação. Para fazer rotação, atualize o webhook com um novo valor.Tipos de evento aos quais este webhook se inscreve. A correspondência é por substring, sem diferenciar maiúsculas e minúsculas: o despachante dispara este webhook quando o nome do evento (em minúsculas) está contido na string
events (em minúsculas). O formato recomendado é uma lista separada por vírgulas com nomes canônicos.Nomes de evento emitidos atualmente:transaction.update.status— uma transação finalizou, falhou ou mudou de estado e o vendedor possui webhooks configurados.
"transaction.") fará a correspondência com qualquer evento futuro cujo nome contenha essa substring.Resposta
Retorna o webhook criado. O camposecret não é retornado.
ID do webhook — armazene-o caso queira atualizar ou remover a assinatura posteriormente.
Formato do payload enviado
Quando a plataforma chama suaurl, o corpo da requisição tem este formato:
secret com o valor que você armazenou localmente (igualdade simples de strings) para autenticar a chamada.
Erros
| Status | Quando |
|---|---|
400 | seller_id não existe ("Seller not found.") ou um campo obrigatório está ausente. |
401 | Token JWT ou chave de API ausente ou inválida. |