> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://ajuda.greenn.com.br/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Documentação Webhook - Greenn

# Documentação Webhook - Greenn

###### Quer saber tudo sobre o nosso Webhook? Vem com a Greenn!

---

* Existem dois tipo de Webhook, sendo eles: **vendas e contratos**.

| **IMPORTANTE:** Data do último Update: 9 de Novembro de 2021 11:31am GMT-03:00 (Três horas a menos no Brasil).

---

# Webhook de Vendas:

**Webhook de Vendas**: Tipo do evento (type) será **"sale"**, o evento é **"saleUpdated"** indicando que a transação teve seu status alterado.

---

### Campos:

**oldStatus**
_Descrição: indica qual o status anterior da venda._
Valores possíveis: created, paid, waiting_payment

**currentStatus**
_Descrição: indica o status atual da venda._
Valores possíveis: paid, refused, refunded, chargedback, waiting_payment

**product.affiliation_proposal**
_Descrição: permite que o afiliado possa gerar propostas._

**product.allow_proposal**
_Descrição: permite ao produto ter propostas_

**product.is_active**
_Descrição: indica se o produto está ativo ou não._

**product.thank_you_page**
_Descrição: página que o usuário será redirecionado após comprar o produto._

**product.affiliation_public**
_Descrição: permite que o produto em questão possa ser exibido na vitrine para que os afiliados possam solicitar afiliação._

**product.affiliation_approbation**
_Descrição: permite que as solicitações de afiliação passem pro aprovação do vendedor ou não._

**product.method**
_Descrição: método de pagamento permitido para este produto._
Valores possíveis: CREDIT_CARD, TWO_CREDIT_CARDS, BOLETO, PIX,PAYPAL (ou todos eles)

**product.type**
_Descrição: indica qual o tipo do produto: simples ou assinatura._
Valores possíveis: TRANSACTIOM, SUBSCRIPTION

**sale.coupon**
_Descrição: indica qual e o cupom que foi aplicado na venda._
Valores possíveis: null, objeto

**saleMetas**
_Descrição: Metas da venda, se houver._
Valores possíveis: \[], Array de Objeto

### Exemplo:

```
{
   "oldStatus":"",
   "currentStatus":"",
   "type":"sale",
   "event":"saleUpdated",
   "product":{
      "affiliation_proposal":1,
      "description":"",
      "allow_proposal":0,
      "created_at":"",
      "is_active":1,
      "period":0,
      "updated_at":"",
      "thank_you_page":"",
      "amount":99,
      "id":0,
      "affiliation_public":1,
      "affiliation_approbation":1,
      "proposal_minimum":0,
      "type":"",
      "method":"",
      "name":""
   },
   "sale":{
      "status":"paid",
      "seller_id":0,
      "created_at":"",
      "updated_at":"",
      "method":"",
      "amount":99,
      "client_id":0,
      "installments":1,
      "type":"",
      "id":0,
     "coupon": {
       "id": 0,
       "seller_id": 0,
       "name": "MEUCUPOM",
       "type": "AMOUNT",
       "amount": 10.0,
       "only_products": 0,
       "limit": 5,
       "due_date": "2021-09-24 12:55:00",
       "created_at": "2021-09-24 12:49:39",
       "updated_at": "2021-09-24 12:51:13",
       "is_active": 0,
       "deleted_at": "2021-09-24 12:51:13"
     }
   },
   "seller":{
      "cellphone":"",
      "email":"",
      "name":"",
      "id":0
   },
   "client":{
      "city":"",
      "neighborhood":"",
      "name":"",
      "cellphone":"",
      "updated_at":"",
      "created_at":"",
      "number":"",
      "zipcode":"",
      "email":"",
      "street":" ",
      "cpf_cnpj":"",
      "complement":"",
      "uf":"",
      "id":0
   },
  "saleMetas": [
    {
      "id": 0,
      "sale_id": 0,
      "meta_key": "",
      "meta_value": "",
      "created_at": "2021-09-24 18:10:30",
      "updated_at": "2021-09-24 18:10:30"
    },
    {
      "id": 0,
      "sale_id": 0,
      "meta_key": "",
      "meta_value": "",
      "created_at": "2021-09-24 18:10:30",
      "updated_at": "2021-09-24 18:10:30"
    }
  ]
}


```

---

# Webhook de contratos:

---

### Campos:

**oldStatus**
_Descrição: indica qual o status anterior do contrato._
Valores possíveis: created, paid, trialing

**currentStatus**
_Descrição: indica o status atual do contrato._
Valores possíveis: paid, trialing, pending_payment, unpaid, canceled

**contract.start_date**
_Descrição: data de início do contrato._

**contract.current_period_end**
_Descrição: data do vencimento da mensalidade atual._

**productMetas**
_Descrição: metas do produto, se houver._

**proposalMetas**
_Descrição: metas da proposta, se houver._

**currentSale.coupon**
_Descrição: indica qual e o cupom que foi aplicado na venda._
Valores possíveis: null, objeto

**saleMetas**
_Descrição: Metas da venda, se houver._
Valores possíveis: \[], Array de Objeto

### Exemplo:

```
{
   "oldStatus":"",
   "currentStatus":"",
   "type":"contract",
   "event":"contractUpdated",
   "product":{
      "affiliation_proposal":1,
      "description":"",
      "allow_proposal":0,
      "created_at":"",
      "is_active":1,
      "period":0,
      "updated_at":"",
      "thank_you_page":"",
      "amount":0,
      "id":0,
      "affiliation_public":1,
      "affiliation_approbation":1,
      "proposal_minimum":0,
      "type":"",
      "method":"",
      "name":""
   },
   "currentSale":{
      "status":"paid",
      "seller_id":0,
      "created_at":"",
      "updated_at":"",
      "method":"",
      "amount":0,
      "client_id":0,
      "installments":1,
      "type":"",
      "id":0,
     "coupon": {
       "id": 0,
       "seller_id": 0,
       "name": "MEUCUPOM",
       "type": "AMOUNT",
       "amount": 10.0,
       "only_products": 0,
       "limit": 5,
       "due_date": "2021-09-24 12:55:00",
       "created_at": "2021-09-24 12:49:39",
       "updated_at": "2021-09-24 12:51:13",
       "is_active": 0,
       "deleted_at": "2021-09-24 12:51:13"
     }
   },
   "contract":{
      "start_date":"",
      "created_at":"",
      "updated_at":"",
      "status":"",
      "current_period_end":"",
      "id":0
   },
   "seller":{
      "cellphone":"",
      "email":"",
      "name":"",
      "id":0
   },
   "affiliate":{
      "cellphone":"",
      "email":"",
      "name":"",
      "id":0
   },
   "client":{
      "city":"",
      "neighborhood":"",
      "name":"",
      "cellphone":"",
      "updated_at":"",
      "created_at":"",
      "number":"",
      "zipcode":"",
      "email":"",
      "street":" ",
      "cpf_cnpj":"",
      "complement":"",
      "uf":"",
      "id":0
   },
   "productMetas":[
     {
      "key":"",
      "value":"",
      "id":0
   	 }
   ],
   "proposalMetas":[
     {
      "key":"",
      "value":"",
      "id":0
   	 }
   ],
  "saleMetas": [
    {
      "id": 0,
      "sale_id": 0,
      "meta_key": "",
      "meta_value": "",
      "created_at": "2021-09-24 18:10:30",
      "updated_at": "2021-09-24 18:10:30"
    },
    {
      "id": 0,
      "sale_id": 0,
      "meta_key": "",
      "meta_value": "",
      "created_at": "2021-09-24 18:10:30",
      "updated_at": "2021-09-24 18:10:30"
    }
  ]
}

```

---

# Objeto do evento "Abandono de Carrinho"

**lead.step**
_Descrição: Qual passo o cliente parou no checkout._

* Valores possíveis: 1, 2, 3

* 1 - dados pessoas.

* 2 - dados de endereço (se houver).

* 3 - dados de pagamento

### Exemplo:

```
"type": "lead",
"event": "checkoutAbandoned",
"lead":{
   "city":"",
   "neighborhood":"",
   "name":"",
   "cellphone":"",
   "updated_at":"",
   "created_at":"",
   "number":"",
   "zipcode":"",
   "email":"",
   "street":" ",
   "cpf_cnpj":"",
   "complement":"",
   "uf":"",
   "step": 1,
   "id":0
},
"product":{
   "affiliation_proposal":1,
   "description":"",
   "allow_proposal":0,
   "created_at":"",
   "is_active":1,
   "period":0,
   "updated_at":"",
   "thank_you_page":"",
   "amount":0,
   "id":0,
   "affiliation_public":1,
   "affiliation_approbation":1,
   "proposal_minimum":0,
   "type":"",
   "method":"",
   "name":""
},
"seller":{
   "cellphone":"",
   "email":"",
   "name":"",
   "id":0
},
"affiliate":{
   "cellphone":"",
   "email":"",
   "name":"",
   "id":0
},
"productMetas":[
   {
   "key":"",
   "value":"",
   "id":0
      }
],
"proposalMetas":[
   {
   "key":"",
   "value":"",
   "id":0
      }
],

```