CUBO CRM
    CUBO CRM
    • Comece por aqui
    • Atividade
      • Listar todas as atividades
        GET
      • Criar nova atividade
        POST
      • Obter atividade por ID
        GET
      • Atualizar atividade
        PUT
      • Excluir atividade
        DELETE
    • Anotação
      • Criar nova anotação
        POST
      • Obter anotação por ID
        GET
      • Atualizar anotação
        PUT
      • Excluir anotação
        DELETE
    • Chave de API
      • Listar todas as chaves de API
        GET
      • Criar nova chave de API
        POST
      • Obter chave de API por ID
        GET
      • Atualizar chave de API
        PUT
      • Excluir chave de API
        DELETE
    • Categoria
      • Listar todas as categorias
        GET
      • Criar nova categoria
        POST
      • Obter categoria por ID
        GET
      • Atualizar categoria
        PUT
      • Excluir categoria
        DELETE
    • Empresa
      • Obter empresa
        GET
      • Atualizar empresa
        PUT
    • Campo Personalizado
      • Listar todos os campos personalizados
        GET
      • Criar novo campo personalizado
        POST
      • Obter campo personalizado por ID
        GET
      • Atualizar campo personalizado
        PUT
      • Excluir campo personalizado
        DELETE
    • Negociação
      • Listar todos os negócios
      • Criar novo negócio
      • Obter negócio por ID
      • Atualizar negócio
      • Excluir negócio
      • Transborda uma negociação específica
    • Dominio
      • Listar todos os domínios
      • Criar novo domínio
      • Obter domínio por ID
      • Excluir domínio
    • Motivo de Perda
      • Listar todos os motivos de perda
      • Criar motivo de perda
      • Obter motivo de perda por ID
      • Atualizar motivo de perda
      • Excluir motivo de perda
    • Organização
      • Listar todas as organizações
      • Criar nova organização
      • Obter organização por ID
      • Atualizar organização
      • Excluir organização
    • Pessoa
      • Listar todas as pessoas
      • Criar nova pessoa
      • Obter pessoa por ID
      • Atualizar pessoa
      • Excluir pessoa
    • Funil
      • Listar todos os funis
      • Criar novo funil
      • Listar funil por ID
      • Atualizar Funil
      • Excluir funil
    • Produto
      • Listar todos os produtos
      • Criar novo produto
      • Obter produto por ID
      • Atualizar produto
      • Excluir produto
    • Proposta
      • Listar todos as propostas
      • Criar proposta para negociação pelo ID
      • Obter proposta por ID
      • Atualizar proposta
    • Estágio
      • Buscar todos os estágios do funil pelo ID
      • Criar estágios
      • Obter estágios por ID
      • Atualizar estágio
      • Excluir estágio
    • Modelo
      • Listar todos os modelos de mensagem
      • Criar modelo de mensagem
      • Criar modelo de mensagem para negócio pelo ID
      • Obter modelo de mensagem por ID
      • Atualizar modelo de mensagem
      • Excluir modelo de mensagem
    • Webhooks
      • Receber dados do BotConversa para criação
      • Receber dados do BotConversa para atualização
      • Receber dados do ManyChat para criação
      • Receber dados do ManyChat para atualização

    Webhook

    Visão Geral#

    Este documento descreve os webhooks suportados pelo sistema para integração com diferentes plataformas externas. Os webhooks permitem que o sistema reaja a eventos que ocorrem nessas plataformas, automatizando a criação ou atualização de negociações e outras informações relevantes.

    Estrutura da Entidade#

    ManyChat#

    Visão Geral#

    Permite integrar o sistema com fluxos de conversação do ManyChat, criando novas negociações ou atualizando negociações existentes com base em eventos definidos no ManyChat.

    Campos#

    CampoTipoDescriçãoObrigatório (Criação)Obrigatório (Atualização)
    pipeIdnumberID do pipeline onde a negociação será criada.✅✅
    apiKeystringChave de API do usuário autenticado no sistema.✅✅
    typestringTipo de evento: create ou update.✅✅
    titlestring (opcional)Título da negociação.✅❌
    peopleNamestring (opcional)Nome da pessoa/contato.✅❌
    peoplePhonestring (opcional)Telefone da pessoa/contato.❌❌
    customfield_<ID>string/number/...Valores para campos personalizados.❌❌
    idnumberID da negociação a ser atualizada.❌✅

    Bot Conversa#

    Visão Geral#

    Permite integrar o sistema com bots de conversa, criando novas negociações ou atualizando negociações existentes com base nas interações do bot.

    Campos#

    CampoTipoDescriçãoObrigatório (Criação)Obrigatório (Atualização)
    pipeIdnumberID do pipeline onde a negociação será criada.✅✅
    apiKeystringChave de API do usuário autenticado no sistema.✅✅
    typestringTipo de evento: create ou update.✅✅
    titlestring (opcional)Título da negociação.✅❌
    peopleNamestring (opcional)Nome da pessoa/contato.✅❌
    peoplePhonestring (opcional)Telefone da pessoa/contato.❌❌
    customfield_<ID>string/number/...Valores para campos personalizados.❌❌
    idnumberID da negociação a ser atualizada.❌✅

    Regras de Negócio#

    ManyChat e Bot Conversa#

    Requer uma apiKey válida para autenticação do usuário.
    Na criação, o pipeId deve ser um ID de pipeline existente e associado à empresa do usuário autenticado.
    Na atualização, o id da negociação deve ser um ID existente.
    Os dados recebidos são usados para criar ou atualizar uma negociação no sistema, incluindo informações de contato e campos personalizados.
    Telefones (phone ou peoplePhone) podem ser formatados, com remoção do sinal de + no Bot Conversa.
    Em caso de erro na criação ou atualização, o webhook retornará uma resposta de erro com detalhes.

    Operações Disponíveis#

    ManyChat e Bot Conversa#

    Criar Negociação (type=create): Cria uma nova negociação no pipeline especificado com os dados fornecidos.
    Atualizar Negociação (type=update): Atualiza uma negociação existente com os dados fornecidos.

    Casos de Uso Detalhados#

    ManyChat#

    Cenário: Um usuário interage com um bot no ManyChat e fornece seus dados de contato e o interesse em um produto específico.
    Fluxo:
    1.
    O bot do ManyChat coleta o nome, telefone e o produto de interesse do usuário.
    2.
    O ManyChat dispara o webhook de criação (type=create) para o sistema, incluindo o pipeId do pipeline de vendas, a apiKey da conta, e os dados do usuário nos campos peopleName, peoplePhone e um campo personalizado customfield_123 (onde 123 é o ID do campo "Produto de Interesse").
    3.
    O sistema recebe a requisição, autentica o usuário pela apiKey e cria uma nova negociação no pipeline especificado com os dados do contato e o produto de interesse.

    Bot Conversa#

    Cenário: Um lead entra em contato através de um widget de chat conectado ao Bot Conversa (UChat) e fornece informações relevantes para uma possível venda.
    Fluxo:
    1.
    O Bot Conversa captura o telefone do lead e as informações sobre o serviço desejado.
    2.
    O Bot Conversa dispara o webhook de criação (type=create) para o sistema, incluindo o apiKey da conta, o pipeId do pipeline de serviços e o telefone do lead no campo peoplePhone. Também pode incluir informações sobre o serviço desejado em um campo personalizado customfield_456.
    3.
    O sistema recebe a requisição, autentica o usuário pela apiKey e cria uma nova negociação no pipeline de serviços com o telefone do lead e o serviço desejado.

    Fluxo de Uso#

    ManyChat e Bot Conversa (Criação)#

    Modificado em 2025-06-16 17:16:06
    Página anterior
    Excluir modelo de mensagem
    Próxima página
    Receber dados do BotConversa para criação
    Built with