Atualizado há 9 meses

Documentação do Webhook

Header

Caso você adicione um token no seu webhook (recomendado), o token será enviado no header das requisições como um Bearer Token, sendo assim é possível você autenticar que as requisições foram enviadas pelo Rifei.

Chave	Valor
Authorization	Bearer SEU_TOKEN_SECRETO

Body

Atributo	Tipo	Descrição
event	string	O tipo do evento (new_order, paid_order ou expired_order)
id	string	Um identificador único do pedido
slug	string	Uma string de identificação única para a campanha
is_rifinha	boolean	Indica se o pedido está associado a uma "rifinha"
buyer.name	string	Nome do comprador
buyer.phone	string	Número de telefone do comprador no formato E.164
buyer.email	null ou string	E-mail do comprador
buyer.document	null ou string	Documento do comprador
buyer.date_of_birth	null ou string	Data de nascimento do comprador no formato DD/MM/YYYY
buyer.address	null ou object	JSON do endereço do comprador
numbers	null ou integer array	Lista de bilhetes comprados pelo usuário
numbers_count	integer	Quantidade de bilhetes comprados pelo usuário
subtotal	number	Valor total sem descontos
total	number	Valor total após descontos
promotion_discount	null ou number	Desconto aplicado devido a promoções
coupon_discount	null ou number	Desconto aplicado devido a um cupom
payment_method	string	Método de pagamento utilizado, como "pix"
status	string	Status do pedido (in_process ou approved)
status_detail	string	Detalhes adicionais sobre o status, como "changed_by_admin", "accredited", etc...
coupon_id	null ou integer	Identificador do cupom usado
affiliate_id	null ou integer	Identificador do afiliado
created_at	string (ISO 8601)	Data e hora de criação do pedido
expires_at	string (ISO 8601)	Data e hora de expiração do pedido
approved_at	null ou string (ISO 8601)	Data e hora em que o pedido foi aprovado
expired_at	null ou string (ISO 8601)	Data e hora em que o pedido foi expirado
upsells	string array	Array com o nome de identificação dos upsells
observation	null ou string	Caso ative o campo de observação no checkout, irá retornar a mensagem que o cliente inseriu
fbp	null ou string	Identificação do navegador caso utilize o Pixel da Meta
fbc	null ou string	Identificação de clique caso utilize o Pixel da Meta
utm.source	null ou string	Parâmetro de URL
utm.campaign	null ou string	Parâmetro de URL
utm.medium	null ou string	Parâmetro de URL
utm.content	null ou string	Parâmetro de URL
utm.term	null ou string	Parâmetro de URL

Payload de exemplo

{
  "event": "paid_order",
  "id": "XXXXXXXXXXX",
  "slug": "demonstracao",
  "is_rifinha": false,
  "buyer": {
    "name": "Fulano de Tal",
    "phone": "+5599999999999",
    "email": null,
    "document": "12345678909",
    "date_of_birth": "20/01/2000",
    "address": {
      "country": "BR",
      "zipcode": "01001000",
      "address": "Rua de exemplo",
      "number": "1000",
      "neighborhood": "Centro",
      "complement": "Sala 1",
      "state": "SP",
      "city": "São Paulo"
    }
  },
  "numbers": [
    5172,
    56653,
    78399,
    37669,
    14891
  ],
  "numbers_count": 5,
  "subtotal": 2.5,
  "total": 1.25,
  "promotion_discount": 1.25,
  "coupon_discount": null,
  "payment_method": "pix",
  "status": "approved",
  "status_detail": "changed_by_admin",
  "coupon_id": null,
  "affiliate_id": null,
  "created_at": "2024-08-23T11:28:45.035-03:00",
  "expires_at": "2024-08-23T12:27:44.892-03:00",
  "approved_at": "2024-08-23T12:09:29.243-03:00",
  "upsells": ["Upsell de demonstração"],
  "observation": "Irei retirar o prêmio no local",
  "utm": {
    "source": "facebook",
    "campaign": "demonstracao",
    "medium": "cpc",
    "content": "link1",
    "term": "term1"
  }
}

Escrito por Equipe Rifei

Atualizado há 9 meses