📡 API: Envio de Eventos para Kwai
Este endpoint permite o envio de eventos do seu site diretamente para a API do Kwai, utilizando integração server-to-server.
Siga as instruções abaixo para garantir o funcionamento correto.
🔗 Endpoint
POST /api/kwai/send-event
Content-Type: application/json
Accept: application/json
📝 Payload esperado
Envie um JSON com os seguintes campos obrigatórios:
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
click_id | string | Sim | Identificador único do clique (gerado pelo seu site ou pelo Kwai) |
event_name | string | Sim | Nome do evento (veja lista de eventos permitidos abaixo) |
pixel_public_id | string | Sim | O public_id do pixel Kwai vinculado ao dashboard/produto |
test_flag | boolean | Não | Se verdadeiro, evento será tratado como teste |
Exemplo de payload
{
"click_id": "LPVB7IlxijTMGwEzFs0DA",
"event_name": "EVENT_CONTENT_VIEW",
"pixel_public_id": "P6840023f8572a0.15411956",
"test_flag": true
}
🎯 Eventos permitidos
Os valores aceitos para event_name
são:
EVENTCONTENTVIEW
EVENTCOMPLETEREGISTRATION
EVENT_SEARCH
EVENTADDTO_WISHLIST
EVENT_CONTACT
Se enviar um evento diferente, a API irá rejeitar.
🟢 Resposta de sucesso
{
"message": "Evento enviado com sucesso"
}
🔴 Resposta de erro
Se faltar algum campo obrigatório ou o pixel não for encontrado:
{
"message": "Pixel não encontrado para o public_id informado.",
"public_id": "P6840023f8572a0.15411956"
}
Se o evento não for permitido:
{
"message": "Evento não permitido"
}
Se houver erro ao enviar para o Kwai:
{
"message": "Erro ao enviar evento para Kwai",
"notes": "Verifique se o click_id está correto e se o pixel está ativo."
}
🆔 Como obter o public_id
do pixel
Via Dashboard:
Acesse a área de Pixels no painel da Utmize.
O campo Public ID estará visível ao lado de cada pixel cadastrado, com um botão de copiar.
💡 Dicas
Sempre envie o header
Accept: application/json
para garantir respostas em JSON.O campo
click_id
deve ser único por evento.O campo
test_flag
pode ser usado para eventos de teste (não afeta métricas reais).
📚 Referências
Se precisar de exemplos de integração em código ou tiver dúvidas sobre o uso do endpoint, entre em contato com o suporte técnico da Utmize.
Ainda precisa de ajuda?
Contate-Nos