Skip to main content

Webhook - Chat

É possivel acionar uma campanha através da sua conta na plataforma chat.vya.digital

Autorização

Para utilização é necessário coletar a sua ApiKey.

Acesse seu perfil na plataforma Journey e selecione Token, sua Chave de API será apresentada. Dúvidas acesse o link Journey - Token

URL

URL Produção: https://app.vya.digital

Campanha

Neste evento, a plataforma Journey receberá do chat os dados do contato criado na plataforma chat.vya.digital.

Podendo assim acionar qualquer campanha contendo sua estratégia de envio de midias.

Campos coletados que serão enviados ao Journey
campo descrição
Nome Nome completo do contato
PrimeiroNome Será interpretado o nome do cliente e separado apenas o Primeiro Nome, permitindo a construção de um texto mais pessoal
Sobrenome Será interpretado o nome do cliente e separado o Sobrenome
Telefone Telefone cadastrado na plataforma
Email Email cadastrado no contato
Atributos do Contato Todos os atributos cadastrado no contato

image.png

Endpoint:

URL: {{baseUrl}}/api/v2/webhook/chat/{{apiKey}}/campanha/{{numero da campanha}}

Response:

Success - 200 OK

{
  "status": true,
  "erro": 0,
  "message": "Registrado com sucesso",
  "codigoAcao": "98883",
  "codigoContatos": [
    19680366
    ]
}

Exemplos de uso:

Automação

Crie uma automação e adicione a Url do WebHook, Para mais detalhes de como criar uma automação acesso o manual do chat

image.png

Neste exemplo de automação para quando o cliente iniciar uma nova conversa, será acionado uma Campanha no Journey, com os dados do contato do cliente.

Integrações Webhooks

Crie um evento webhook para quando cadastrar um novo contato e adicione o webhook, Para mais detalhes de como criar um webhook acesso o manual do chat

image.png

Back to top