# 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>.&#x20;

<figure><img src="https://3344509428-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FD0KchSWN381W9S4GFEfY%2Fuploads%2FgSKeIvxgiq3pw5ed1exJ%2Fwebhook2.jpg?alt=media&#x26;token=90cb78d9-5d88-49c5-a90c-db78ebd1e074" alt=""><figcaption></figcaption></figure>

Exemplo de Payload:

```
{
  "id": "evt_123456789",
  "data": {
    "ca": "code-afilliate",
    "email": "john.doe@example.com",
    "order": "A1B2C3D4E5",
    "coupons": [],
    "product": {
      "name": "Fictional Product",
      "price": 4999,
      "format": "PHYSICAL",
      "description": "Sample product description",
      "email_support": "support@example.com",
      "shipping_price": 999
    },
    "user_id": "usr_9876543210zyxwv",
    "customer": {
      "name": "JANE SMITH",
      "email": "jane.smith@mailinator.com",
      "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:

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