Pular para o conteúdo principal

Webhook

Use nossos Eventos Webhook para receber notificações em tempo real sobre diversas atividades.

Na Hubpontos, utilizamos webhooks para comunicar eventos importantes, como atualizações de solicitações de produtos, alterações no cadastro de usuários e movimentações de pontos.

Enviamos requisições HTTP POST para um endpoint de URL fornecido e configurado no seu ambiente, preparado para receber e processar essas notificações.

O que são Webhook Events?​

Os Webhook Events da Hubpontos permitem que você receba notificações automáticas sobre diversas atividades, incluindo:

  • Atualizações de solicitações de produtos
  • Modificações no cadastro de usuários
  • Alterações e movimentações de pontos

Como funciona?​

A Hubpontos envia requisições HTTP POST para um endpoint de URL definido por você, hospedado no seu ambiente e pronto para processar esses eventos.

Nós oferecemos uma variedade de eventos que podem disparar notificações via webhook, organizados nas seguintes categorias:

Como configurar?​

Para fazer a configuração dos Webhooks é necessário acessar o painel com seu usuário Admin e ir até a opção Configurações no menu lateral. Nas Configurações você deve ir até a aba Webhook onde vai encontrar os campos para colocar a URL da API e a chave de autenticação.

Atenção

Para que o Webhook seja utilizado em produção será necessário comunicar nossa equipe, que fará uma análise e aprovação dos endpoints. Favor enviar um e-mail para suporte@hub4pay.io para a aprovação do webhook.

Autenticação​

Se o seu ambiente exigir autenticação, você poderá configurar um Bearer Token que será incluído no cabeçalho das requisições HTTP.

Headers

Authorization: Bearer <<YOUR_API_KEY_HERE>>

Request body​

Edição de pessoa​

O endpoint de edição de pessoa tem como propósito fornecer os dados atualizados do usuário sempre que uma modificação for realizada.

{
    fullName: "string",
    email: "string",
    birthDate: '2012-04-23T18:25:43.511Z',
    gender: "string",
    phone: "string",
    street: "string",
    number: "string",
    complement: "string",
    zipCode: "string",
    city: "string",
    state: "string",
    country: "string",
}

Alteração de Saldo​

O endpoint de Alteração de Saldo tem como objetivo fornecer os dados atualizados do saldo de um usuário sempre que houver uma modificação.

    personId uuidrequired

    O identificador único do usuário participante.

    year intrequired

    Ano de referência da importação do saldo do usuário.

    month intrequired

    Mês de referência da importação do saldo do usuário.

    value intrequired

    Valor específico da alteração do saldo.

    total intrequired

    Total acumulado do saldo do usuário após a alteração.

    type stringrequired

    Default value: income, expense

    Tipo da alteração: entrada ou saída de saldo.

    reason stringrequired

    Default value: import_sale, import_product, update_order, training, expired, product, edit

    Motivo que justifica a alteração do saldo.

    expirationDate stringrequired

    Data de expiração do saldo, aplicável para novos saldos adicionados.

Resgate de Produtos​

O endpoint de Resgate de Produtos tem como finalidade fornecer os dados do pedido de resgate realizado pelo usuário.

    userId uuidrequired

    Identificador do usuário que fez o pedido.

    status stringrequired

    Status atual do pedido.

    totalCoins integerrequired

    Total de moedas usadas para realizar o pedido, incluindo preço, serviço (se houver) e frete (se houver).

    orderItems objectrequired

    Armazena os dados do item do pedido.

    orderItems.orderItemCode stringrequired

    Código de identificação gerado para o item do pedido.

    orderItems.productTags string[]

    Lista de identificadores das tags que o item pode ter (ex: tag 220v).

    orderItems.cardNumber string

    Número do cartão para recarga.

    orderItems.cardCpf string

    CPF vinculado à recarga.

    orderItems.cardDate string

    Data de validade do cartão.

    orderItems.rechargeNumber string

    Número de telefone para recarga.

    orderItems.ticketCode string

    Código do boleto.

    orderItems.ticketDescription string

    Descrição do boleto.

    orderItems.ticketDueAt date

    Data de vencimento do boleto.

    orderItems.ticketType string

    Tipo de boleto.

    orderItems.ticketValue integer

    Valor do boleto em pontos.

    orderItems.quantity integerrequired

    Quantidade de itens iguais no pedido.

    orderItems.amount integerrequired

    Valor unitário do item em pontos.

    orderItems.services integerrequired

    Valor total dos serviços (considerando quantidade).

    shipping integer

    Valor do envio em pontos.

    shippingResponsible string

    Empresa responsável pelo envio (ex: Jadlog).

    shippingCarrier string

    Tipo de envio (ex: Sedex).

    shippingDays integer

    Dias estimados para entrega.

    shippingPrice integer

    Valor do frete em reais.

    address object

    Campos de endereço.

    recipient string

    Nome do destinatário.

    street string

    Nome da rua.

    number string

    Número do endereço.

    complement string

    Complemento do endereço.

    zipCode string

    CEP.

    city string

    Cidade.

    state string

    Estado.

    observations string

    Observações adicionais.

Responses​

Resposta de Sucesso!