API Reference

Webhooks

O Atendare conta com a função de Webhooks através de suas automações.

As requisições são do tipo POST

Os possíveis payloads são:

Contatos

{
  "event_action": "automation",
  "event_object": "contact",
  "timestamp": "2024-01-04T17:30:38.9387706Z",
  "payload": {
    "id": 16617,
    "name": "Nome do Contato",
    "full_name": "Nome Completo do Contato",
    "email": "[email protected]",
    "phone": null,
    "document": null,
    "responsible": null
  }
}

Empresas

{
  "event_action": "automation",
  "event_object": "company",
  "timestamp": "2024-01-04T17:34:11.3915475Z",
  "payload": {
    "id": 16620,
    "name": "Nome Fantasia",
    "full_name": "Razão Social",
    "email": null,
    "phone": null,
    "document": null,
    "responsible": {
      "id": 48,
      "name": "Usuários",
      "full_name": "Usuário Responsável",
      "email": "[email protected]"
    }
  }
}

Qualificações

{
  "event_action": "automation",
  "event_object": "qualification",
  "timestamp": "2024-01-04T17:36:36.1511333Z",
  "payload": {
    "id": 6161,
    "name": "Q478 - Qualificação",
    "number": 478,
    "stage": {
      "id": 56,
      "name": "Coletando dados",
      "status": 1
    },
    "pipeline": {
      "id": 4,
      "name": "Prospecção Ativa (Outbound)"
    },
    "responsible": {
      "id": 48,
      "name": "Responsavel",
      "full_name": "Nome Responsavel",
      "email": "[email protected]"
    },
    "contact": {
      "id": 16275,
      "name": "Nome",
      "full_name": "Nome do Contato",
      "email": "[email protected]",
      "phone": null,
      "document": null
    },
    "company": {
      "id": 98,
      "name": "Empresa",
      "full_name": "Empresa Ltda",
      "email": "[email protected]",
      "phone": "+55 35358128",
      "document": null
    }
  }
}

Negociações

{
  "event_action": "automation",
  "event_object": "deal",
  "timestamp": "2024-01-04T17:40:18.8170346Z",
  "payload": {
    "id": 6162,
    "name": "NGC467 - Negociação",
    "number": 467,
    "stage": {
      "id": 20,
      "name": "SQL",
      "status": 1
    },
    "pipeline": {
      "id": 5,
      "name": "Funil de Vendas"
    },
    "responsible": {
      "id": 48,
      "name": "Responsavel",
      "full_name": "Nome Responsavel",
      "email": "[email protected]"
    },
    "contact": null,
    "company": {
      "id": 16620,
      "name": "Empresa",
      "full_name": "Empresa Ltda",
      "email": "[email protected]",
      "phone": "+55 35358128",
      "document": null
    }
  }
}