Webhooks

Os webhooks permitem que suas integrações executem uma ação em resposta a eventos que ocorrem com suas avaliações ou perguntas e respostas

Eventos disponíveis

Evento	Disparo	Campos
review	Uma nova avaliação de produto é realizada	avaliações de produto
review-update	Uma avaliação é atualizada (fotos são enviadas, recebe uma resposta, é publicada ou removida, etc)	avaliações de produto
store-review	Uma nova avaliação de loja é realizada	avaliações de loja
store-review-update	Uma avaliação de loja é atualizada (recebe uma resposta, é publicada ou removida, etc)	avaliações de loja

Configurando o webhook

Atualmente, a configuração dos webhooks é feita pelo nosso time de suporte. Basta enviar um e-mail para [email protected] ou entrar em contato com seu especialista de sucesso do cliente com as seguintes informações:

• Endpoint que receberá as notificações
• Uma chave secreta que será utilizada para validar que as informações vieram de nosso sistema (recomendado um mínimo de 64 caracteres)
• Quais eventos serão enviados para este endpoint

dica

Nossos webhooks sempre enviam as informações através do método HTTP POST, com o payload no formato JSON

Payload do webhook

{
    "key": "8f6df519a2125946820bc34a561164c2",
    "action": "review",
    "data": {
       "status":"sent",
       "_id":"65a0519a796e57c44eddfb3b",
       "created":"2024-01-11T20:37:46.019Z",
       "customer":"konfidency",
       "sku":"9",
       "name":"Tony S",
       "text":"Amei o produto",
       "rating": 5,
        "helpful": 4,
        "unhelpful": 0,
        "verified": false,
        "recommended": true
    }
}

Campos

campo	descrição	tipo de dados
key	chave secreta	string
action	tipo de evento, conforme tabela	string
data	informações do objeto (avaliação, pergunta)	object

Detalhes dos eventos

Campos de dados de webhooks de avaliação de produto

campo	descrição	tipo de dados
_id	ID único da avaliação	string
status	status da avaliação, normalmente será "sent" neste momento	string
created	data do envio da avaliação	string (data em formato ISO-8601)
userId	ID do usuário que realizou a avaliação	string
name	nome do cliente que fez a avaliação	string
sku	SKU do produto	string
rating	número de estrelas atribuído pelo usuário ao produto	integer
text	texto de avaliação do cliente	string
recommended	indica se o cliente avalia o produto positivamente	boolean
verified	indica se o cliente é um comprador verificado do produto	boolean
helpful	quantidade de pessoas que consideraram a avaliação útil	integer
unhelpful	quantidade de pessoas que não consideraram a avaliação útil	integer
pictures	fotos incluídas na avaliação	array

Campos de dados de webhooks de avaliação de loja

campo	descrição	tipo de dados
_id	ID único da avaliação	string
status	status da avaliação, normalmente será "sent" neste momento	string
created	data do envio da avaliação	string (data em formato ISO-8601)
userId	ID do usuário que realizou a avaliação	string
name	nome do cliente que fez a avaliação	string
rating	número de estrelas atribuído pelo usuário ao produto	integer
text	texto de avaliação do cliente	string
verified	indica se o cliente é um comprador verificado do produto	boolean
helpful	quantidade de pessoas que consideraram a avaliação útil	integer
unhelpful	quantidade de pessoas que não consideraram a avaliação útil	integer