POST/v1/e

Registrar evento

Recebe eventos do SDK e do service worker: entrega, clique e fechamento de notificação, além de eventos personalizados enviados com pushwi("track", …). Os eventos são agregados em lote, então podem levar até um minuto para aparecer nos relatórios.

O site vai no corpo (site), não no caminho.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Parameters

Values are applied to the request and the example on the right.

X-Pushwi-Endpointheader · stringoptional

URL do endpoint de push do dispositivo, quando houver inscrição. Liga o evento ao assinante.

Request body

application/jsonrequired

sitestringrequired

ID público do site.

typeenumrequired

Values: "delivered" · "clicked" · "closed" · "custom"

eventstringoptional

Nome do evento personalizado. Obrigatório quando type é custom. Até 64 caracteres entre letras, números e _ . : -.

propsobjectoptional

Até 20 propriedades com valores simples (texto até 255 caracteres, número, booleano ou null). Só são gravadas em eventos custom.

campaign_idintegeroptional

subscriber_idstring · uuidoptional

variant_idintegeroptional

button_indexintegeroptional

Botão clicado, a partir de 0. -1 quando o clique foi no corpo da notificação.

Responses

204

Evento aceito. Sem corpo.

403application/json

O cabeçalho Origin está ausente ou não consta nas origens permitidas do site.

{
  "message": "Origem não permitida."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

404application/json

Nenhum site com esse ID público.

{
  "message": "Recurso não encontrado."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

422application/json

Algum campo não passou na validação. errors traz a mensagem de cada campo.

{
  "message": "O campo content.title é obrigatório.",
  "errors": {
    "content.title": [
      "O campo content.title é obrigatório."
    ]
  }
}

messagestringoptional

Primeira mensagem de erro.

errorsobjectoptional

Mensagens por campo. A chave é o caminho do campo com pontos, como content.title ou definition.groups.0.rules.1.op.

429application/json

Limite de requisições excedido. Espere os segundos indicados em Retry-After.

{
  "message": "Muitas requisições. Tente novamente em instantes."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.