Integrações

O novo menu deixa a spread ainda mais flexível e preparada para se conectar com todo o ecossistema de ferramentas da sua operação.

O menu de Integrações permite conectar a spread a sistemas externos de forma simples e automática, usando webhooks. Com isso, eventos que acontecem dentro da plataforma podem ser enviados em tempo real para APIs externas.

Ao clicar em Novo Webhook, você poderá configurar os seguintes campos:

• Nome: Identificação interna do webhook. Serve apenas para organização no painel.

• URL: Endpoint da API externa que irá receber as informações enviadas pela spread.

• Eventos: Aqui você escolhe quais ações da spread irão disparar o webhook. É possível selecionar um ou vários eventos, como:

Conversa iniciada

Disparado quando um contato inicia uma nova conversa. Retorna informações como:

{
  "type": "chats_start",
  "data": [
    {
      "id": "697bb53a8851dfb0e97be168",
      "dateStart": "2026-01-29T19:30:02.845Z",
      "contactId": "ID do contato",
      "lastMessage": "Olá",
      "referral": {},
      "chatType": "whatsapp",
      "chatChannel": "Número associado"
    }

Conversa finalizada

Disparado quando a conversa é encerrada (manual ou automaticamente). Retorna:

{
  "type": "chats_end",
  "data": [
    {
      "id": "697bbe298851dfb0e99e294e",
      "dateEnd": "2026-01-29T20:08:38.274Z",
      "endSource": "inbox",
      "endedBy": "625477f68ce353c8880f914b",
      "lastOperatorId": "625477f68ce353c8880f914b",
      "contactId": "63979114085",
      "lastMessage": "Olá, bem vindo a *spread.chat*! 🟡",
      "sectorId": "60d5e1bdd197ce0755d9b9d1",
      "tags": [],
      "referral": {},
      "chatType": "whatsapp",
      "messages": [
        {
          "id": "697bbe2ae7a15249ae255bcd",
          "type": "chat",
          "date": "29/01/2026 17:08:10",
          "message": "Olá",
          "way": "received",
          "operatorName": "spread.chat",
          "contactName": "Julia",
          "urlMidia": "",
          "urlMidiaDownload": "",
          "fileName": "",
          "referMessageId": "",
          "isComment": false,
          "error": false,
          "errorMessage": ""
        },
        {
          "id": "697bbe2ad9a4703edb3f0b82",
          "type": "chat",
          "date": "29/01/2026 17:08:10",
          "message": "Olá, bem vindo a *spread.chat*! 🟡",
          "way": "sent",
          "operatorName": "spread.chat",
          "contactName": "Julia",
          "urlMidia": "",
          "urlMidiaDownload": "",
          "fileName": "",
          "referMessageId": "",
          "isComment": false,
          "error": false,
          "errorMessage": ""
        },
        {
          "id": "83492fa4-c445-44a0-8c5b-b1056a697038",
          "type": "chat",
          "date": "29/01/2026 17:08:38",
          "message": "Agradecemos o seu contato😄.  Não se esqueça de avaliar nosso atendimento",
          "way": "sent",
          "operatorName": "spread.chat",
          "contactName": "Julia",
          "urlMidia": "",
          "urlMidiaDownload": "",
          "fileName": "",
          "referMessageId": "",
          "isComment": false,
          "error": false,
          "errorMessage": ""
        }

Conversa transferida por humano

Disparado quando um atendente transfere a conversa manualmente. Retorna:

{
  "type": "chats_transfer",
  "data": [
    {
      "id": "697bc5388851dfb0e9c16cc2",
      "chatType": "whatsapp",
      "chatChannel": "Número associado",
      "newOperatorAssigned": "670e656846fd64d37515b87d",
      "lastOperatorAssigned": "625477f68ce353c8880f914b",
      "sectorId": "60d5e1bdd197ce0755d9b9d1",
      "contactId": "ID do contato",
      "tags": [
        "65e0d96e66638e8211b82b20"
      ],
      "lastMessage": "Qual o motivo principal do seu contato? "
    }

Conversa transferida pelo bot

Disparado quando o chatbot transfere a conversa (ex: para um setor ou atendente). Retorna:

{
  "type": "chats_gush",
  "data": [
    {
      "id": "697bbcb08851dfb0e997afe2",
      "chatType": "whatsapp",
      "chatChannel": "número associado",
      "operatorAssigned": "625477f68ce353c8880f914b",
      "sectorId": "60d5e1bdd197ce0755d9b9d1",
      "contactId": "ID do contato",
      "tags": [
        "65e0d96e66638e8211b82b20"
      ],
      "lastMessage": "Obrigado, Luana. Estou te transferindo para um operador, só um momento."
    }

Etiqueta adicionada à conversa

Disparado sempre que uma etiqueta (tag) é adicionada. Retorna:

{
  "type": "chats_tags_add",
  "data": [
    {
      "chatId": "6980ade68851dfb0e9fa099b",
      "chatType": "whatsapp",
      "chatChannel": "número associado",
      "tagsAdded": [
        "ID DA TAG"
      ]

Etiqueta removida da conversa

Disparado quando uma etiqueta é removida da conversa. Retorna:

{
  "type": "chats_tags_remove",
  "data": [
    {
      "chatId": "6980ade68851dfb0e9fa099b",
      "chatType": "whatsapp",
      "chatChannel": "número associado",
      "tagsRemoved": [
        "65e0d96e66638e8211b82b20"
      ],
      "sectorId": "60d5e1bdd197ce0755d9b9d1"
    }

Avaliação do atendimento

Disparado quando o contato responde a uma pesquisa de satisfação usando o link padrão da spread. Retorna:

{
  "type": "chats_rating",
  "data": [
    {
      "id": "6980ade68851dfb0e9fa099b",
      "chatType": "whatsapp",
      "chatChannel": "número associado",
      "rating": 5,
      "comment": "Ótimo atendimento",
      "sectorId": "60d5e1bdd197ce0755d9b9d1",
      "contactId": "63979114085",
      "tags": []
    }

Status do envio da mensagem

Disparado quando é enviado um template e ele retorna se a ação foi bem sucedida ou se retornou algum erro. Retorna:

Em casos que o envio foi um sucesso:
{
  "type": "message_send_status",
  "data": {
    "from": "número associado",
    "to": "número do contato",
    "message": "Olá, Cadu, Tudo bem? Você já conhece sobre a spread.chat?",
    "status": "sent",
    "error": null,
    "contactId": "154076670562"
  }
  
Caso o envio tenha retornado algum erro:
{
  "type": "message_send_status",
  "data": {
    "from": "número associado",
    "to": "número do contato",
    "message": "Olá, Cadu, Tudo bem? Você já conhece sobre a spread.chat?",
    "status": "failed",
    "error": "Message undeliverable",
    "contactId": "154076670562"
  }

Sempre que um desses eventos acontecer, a spread enviará automaticamente os dados para a URL configurada.