Webhook

Na Maisfy usamos o webhook para integração com plataformas externas, e os eventos que reportamos sao:

• Pedido Cancelado

• Pedido Pago

• Pedido Pendente

Para criar um webhook para o seu produto vá em https://app.maisfy.com.br/webhooks.

Exemplo de Payload:

{
  "id": "evt_123456789",
  "data": {
    "ca": "code-afilliate",
    "email": "[e-mail]",
    "order": "A1B2C3D4E5",
    "coupons": [],
    "product": {
      "name": "Fictional Product",
      "price": 4999,
      "format": "PHYSICAL",
      "description": "Sample product description",
      "email_support": "[e-mail]",
      "shipping_price": 999
    },
    "user_id": "usr_9876543210zyxwv",
    "customer": {
      "name": "JANE SMITH",
      "email": "[e-mail]",
      "address": {
        "city": "São Paulo",
        "state": "SP",
        "number": "456",
        "address": "Avenida Paulista, 1234",
        "zip_code": "01310-000"
      },
      "cellphone": "(11) 98765-4321"
    },
    "interest": 0,
    "affiliate": null,
    "parameters": {
      "prod": "Prod1234",
      "utm_id": "123456",
      "utm_term": "fake+product",
      "utm_medium": "cpc",
      "utm_source": "google",
      "utm_content": "banner_ad",
      "utm_campaign": "summer2023"
    },
    "installments": 1,
    "payment_type": "pix",
    "product_code": "Prod1234",
    "total_amount": 5998,
    "checkout_code": "ChkOut5678",
    "interest_free": true,
    "checkout_price": 5998,
    "total_discount": 0,
    "financial_status": "PENDING"
  },
  "event": "order.created",
  "creation_date": "2023-10-15T12:34:56.789Z"
}

e a variavel é o campo "event", que pode ter as seguintes possibilidades:

"event": "order.created",

"event": "order.canceled",

"event": "order.paid",

Parâmetros do Payload:

Campo	Tipo	Descrição
id	string	Identificador único do evento do webhook.
event	string	Tipo do evento (order.created).
creation_date	string	Data e hora da criação do evento no formato ISO 8601.
data.ca	string/null	Campo opcional para informações adicionais.
data.email	string	E-mail do usuário associado ao pedido.
data.order	string	Código do pedido.
data.coupons	array	Lista de cupons aplicados no pedido.
data.product.name	string	Nome do produto comprado.
data.product.price	integer	Preço do produto em centavos.
data.product.format	string	Tipo do produto (PHYSICAL, DIGITAL).
data.product.description	string	Descrição do produto.
data.product.email_support	string	E-mail de suporte do produto.
data.product.shipping_price	integer	Valor do frete em centavos.
data.user_id	string	Identificador único do usuário que fez o pedido.
data.customer.name	string	Nome do cliente.
data.customer.email	string	E-mail do cliente.
data.customer.address.city	string	Cidade do cliente.
data.customer.address.state	string	Estado do cliente.
data.customer.address.number	string	Número do endereço do cliente.
data.customer.address.address	string	Endereço do cliente.
data.customer.address.zip_code	string	CEP do cliente.
data.customer.cellphone	string	Número de celular do cliente.
data.interest	integer	Valor de juros aplicados (em centavos).
data.affiliate	string/null	Identificação do afiliado, caso aplicável.
data.parameters.prod	string	Código do produto.
data.parameters.utm_id	string	ID da campanha UTM.
data.parameters.utm_term	string	Termo de pesquisa associado à campanha UTM.
data.parameters.utm_medium	string	Meio de tráfego (cpc, organic, etc.).
data.parameters.utm_source	string	Fonte de tráfego (google, facebook, etc.).
data.parameters.utm_content	string	Conteúdo do anúncio UTM.
data.parameters.utm_campaign	string	Nome da campanha UTM.
data.installments	integer	Número de parcelas do pagamento.
data.payment_type	string	Método de pagamento (pix, credit_card, etc.).
data.product_code	string	Código identificador do produto.
data.total_amount	integer	Valor total do pedido em centavos.
data.checkout_code	string	Código do checkout.
data.interest_free	boolean	Indica se a compra foi feita sem juros (true ou false).
data.checkout_price	integer	Valor total do checkout em centavos.
data.total_discount	integer	Valor total de descontos aplicados em centavos.
data.financial_status	string	Status financeiro do pedido (PENDING, APPROVED, CANCELED, etc.).