Configurar integrações no Drimify (Webhooks e e-mail)

As integrações do Drimify permitem enviar automaticamente dados dos participantes para serviços externos sempre que um utilizador interage com a sua aplicação. Pode estabelecer ligação a uma API personalizada, ao HubSpot ou ao Salesforce e, em cada integração, definir exatamente que campos de dados são enviados.

Primeiros passos

Se ainda não tiver configurado nenhuma integração, verá a mensagem "Ainda não existem integrações de webhook" ou "Ainda não existem integrações de e-mail".
Clique em + Adicionar nova integração (disponível tanto no canto superior direito como no centro da página) para abrir o seletor de integrações.

Integrações de webhook

Selecionar um tipo de integração

Será apresentada uma janela com o título "Selecionar integração de webhook".
Pode filtrar por categoria através do menu pendente (a opção predefinida é Todas). Estão disponíveis três integrações:

• API personalizada — para qualquer endpoint de uma API REST que controle
• HubSpot — para CRM e automatização de marketing através do HubSpot
• Salesforce — para o CRM Salesforce

Clique no bloco da integração que pretende configurar.

Integração com uma API personalizada

Autenticação

Depois de selecionar API personalizada, abre-se o painel Adicionar integração, com os seguintes campos:

• Nome da integração: Um nome para sua referência (predefinição: "Integração com API personalizada"). Pode alterá-lo para um nome mais descritivo.
• Endpoint da API: O URL completo do serviço que recebe o webhook (por exemplo: https://api.example.com/webhook). Tem de ser um endpoint HTTPS.
• Método HTTP:

Selecione o método HTTP utilizado para enviar o pedido de webhook para o seu endpoint.
Opções disponíveis:

• POST — Recomendado para a maioria dos casos (cria um novo recurso ou envia dados)
• PUT — Substitui integralmente um recurso existente
• PATCH — Atualiza parcialmente um recurso existente

Escolha o método adequado à forma como a sua API espera receber os dados.

• Tipo de autenticação: Escolha o método de autenticação utilizado pelo seu endpoint.

• Ao selecionar Autenticação básica, são apresentados dois campos: Nome de utilizador e Palavra-passe. Introduza os dados tal como são — o Drimify gera automaticamente o cabeçalho Authorization: Basic. Não precisa de os codificar.
• Ao selecionar Cabeçalho personalizado, é apresentado um campo adicional, Nome do cabeçalho personalizado, onde pode introduzir o nome da chave do cabeçalho.
• Chave de API: O valor secreto enviado através do método de autenticação selecionado.
• Verificar ligação: Clique neste botão para testar se o Drimify consegue estabelecer ligação ao seu endpoint com as credenciais fornecidas antes de guardar.

Obter o token a partir de um endpoint de autenticação (pedido prévio)

Algumas APIs exigem uma autenticação inicial: é necessário fazer um pedido a um endpoint de autenticação com as suas credenciais, receber um token e utilizá-lo no pedido de webhook. O Drimify permite automatizar este processo.

Quando o tipo de autenticação é Chave de API, Token Bearer ou Cabeçalho personalizado, é apresentada a caixa de seleção "Obter este token a partir de um endpoint de autenticação". Ao selecioná-la, o campo da credencial estática é substituído pelas definições do pedido prévio apresentadas abaixo (no caso de um cabeçalho personalizado, o campo do nome do cabeçalho mantém-se visível — o token obtido é enviado nesse cabeçalho).

O token obtido é incluído de acordo com o tipo de autenticação:

• Token Bearer → Authorization: Bearer <token>
• Chave de API → X-API-KEY: <token>
• Cabeçalho personalizado → <your header name>: <token>

Escolher um dos três métodos

OAuth2 (client_credentials) — para servidores OAuth2 que seguem a norma (por exemplo, Keycloak).

• Campos: URL do token, ID do cliente, Segredo do cliente, Âmbito (opcional)
• O Drimify envia um pedido OAuth2 do tipo client_credentials e obtém o token a partir de access_token. O prazo de validade do token é o indicado pelo servidor em expires_in.

Login JSON — para endpoints de início de sessão que aceitam um corpo JSON e devolvem um token.

• Campos: URL de autenticação, Corpo (lista de pares chave/valor), Caminho do token
• O Drimify envia um pedido POST com um corpo JSON gerado a partir das linhas de pares chave/valor (por exemplo, as linhas email = a@b.com e password = secret produzem {"email":"a@b.com","password":"secret"}).
• O Caminho do token indica ao Drimify onde se encontra o token na resposta JSON, utilizando a notação por pontos — por exemplo, data.access_token ou apenas token, se estiver no nível de topo.

Personalizado — para os casos que não se enquadram nos dois métodos anteriores.

• Campos: URL de autenticação, Método HTTP (POST ou GET), Cabeçalhos (lista de pares chave/valor), Corpo (lista de pares chave/valor), Codificação do corpo (JSON ou form-urlencoded), Caminho do token
• Com o método GET, o pedido não tem corpo — envie os parâmetros através dos cabeçalhos ou do URL de autenticação.
• Se adicionar manualmente um cabeçalho Content-Type, este tem prioridade sobre o cabeçalho definido pela codificação do corpo.

Listas de pares chave/valor (corpo e cabeçalhos)

Cada linha tem uma chave, um valor e uma caixa de seleção "Sensível" (selecionada por predefinição). Pode adicionar e remover linhas, mas não pode editá-las diretamente — para alterar uma linha, remova-a e volte a adicioná-la. Só pode assinalar um valor como sensível ao adicionar a linha. Depois de guardar, os valores sensíveis ficam ocultos e nunca voltam a ser apresentados, nem no formulário nem nos registos.

Tokens em cache e novas tentativas

• Os tokens OAuth2 são guardados em cache durante o período indicado em expires_in.
• Para Login JSON e Personalizado, defina a Validade do token (minutos) — se deixar o campo em branco, é aplicado o valor predefinido de 60 minutos.
• Os tokens são mantidos em cache durante um máximo de 7 dias.
• Se o seu endpoint devolver 401 enquanto estiver a ser utilizado um token em cache, o Drimify elimina esse token, volta a autenticar-se e repete o pedido uma vez.
• Se o pedido prévio falhar (por erro, tempo limite excedido ou ausência de token no caminho indicado), o webhook não é enviado sem autenticação — a entrega falha, a falha é registada e a fila de entrega volta a tentar, como habitualmente.

Verificar a ligação com um pedido prévio

O botão Verificar ligação também permite testar o pedido prévio: primeiro, o Drimify autentica-se no seu endpoint de autenticação e, em seguida, executa o pedido de teste com o token obtido.

Integração com o HubSpot

Depois de selecionar HubSpot, o painel apresenta:

• Nome da integração: Predefinição: "Integração com o HubSpot".
• Chave de API / Token de acesso: Cole aqui o token de acesso da sua aplicação privada do HubSpot. O HubSpot descontinuou as antigas chaves de API em 2022, pelo que tem de utilizar um token de aplicação privada gerado na sua conta HubSpot em: Definições → Integrações → Aplicações privadas
• Verificar ligação: Testa o token na API do HubSpot antes de guardar.

Integração com o Salesforce

Depois de selecionar Salesforce, o painel apresenta:

• Nome da integração: Predefinição: "Integração com o Salesforce".
• Domínio Salesforce: O URL da sua instância Salesforce (por exemplo: yourcompany.my.salesforce.com).
• Consumer Key e Consumer Secret: Obtidos a partir de uma aplicação ligada configurada no Salesforce em: Configuração → Gestor de aplicações → Nova aplicação ligada. O Drimify utiliza o fluxo Client Credentials do OAuth 2.0.
• Nome do campo de ID externo: O nome de API do campo utilizado para identificar os registos nas operações de criação ou atualização (upsert), normalmente Email_External_Id__c ou outro campo personalizado de ID externo no objeto Contacto. Este campo tem de estar assinalado como ID externo no Salesforce. O Drimify cria ou atualiza Contactos. Os leads ainda não são suportados.
• Origem do ID externo: Um menu pendente que permite selecionar o campo de dados do Drimify a utilizar como chave de correspondência (por exemplo: Email).
• Verificar ligação: Testa a ligação OAuth ao Salesforce antes de guardar.

⚠️ Campos obrigatórios do Salesforce

O Salesforce exige o preenchimento de determinados campos no objeto Contacto. Para criar um contacto, o Salesforce exige, no mínimo:

• lastName

Embora o Email não seja obrigatório no esquema predefinido do Salesforce, é quase sempre necessário como ID externo para identificar corretamente os registos e evitar duplicados nas operações de criação ou atualização. Sem uma correspondência fiável através do ID externo, o Salesforce pode criar registos duplicados ou devolver um erro.

Boa prática

Mapeie sempre, pelo menos:

• Apelido
• Email

ao configurar a ligação ao Salesforce. Se não incluir o Apelido, o webhook falhará e o registo não será criado nem atualizado.

Mapear campos

Disponível nos três tipos de integração, a opção Mapear campos permite definir exatamente que campos de dados do Drimify são enviados para a sua integração e com que nomes de chave.
Clique em + Adicionar campo para adicionar uma linha de mapeamento.

Cada linha inclui:

• Campo do webhook (à esquerda) — o nome da chave que será incluída nos dados enviados (definido por si de acordo com os requisitos da sua integração)
• → Campo de origem (menu pendente à direita) — a origem do valor deste campo. Pode:
• • Selecionar um campo de dados do Drimify (por exemplo, Referência da aplicação, Email, Pontuação) para enviar um valor dinâmico recolhido a partir da participação
  • Selecionar Valor estático para enviar um valor fixo sempre que o webhook é acionado — será apresentado um campo de texto adicional onde pode introduzir o valor (por exemplo, My_Value). Esta opção é útil para enviar constantes, como o nome de um evento, um identificador de origem ou uma etiqueta de ambiente.

Campos de origem disponíveis no Drimify

Pode adicionar os mapeamentos de que precisar.
Para remover um mapeamento, clique no ícone do caixote do lixo à direita da linha.## Indicar no seu CRM que um contacto veio da Drimify

A Drimify não define a origem automaticamente, mas pode fazê-lo através do mapeamento de campos, tanto no Salesforce como no HubSpot:

1. No seu CRM, crie um campo para guardar a origem. No Salesforce, deve ser um campo de texto no objeto Contacto (por exemplo, Drimify_Source__c). No HubSpot, deve ser uma propriedade de contacto (por exemplo, drimify_source).
2. Na sua integração da Drimify, abra Mapear campos e adicione uma linha com o nome de API desse campo à esquerda. Selecione Valor estático à direita e introduza Drimify.
3. Para saber em que experiência o contacto participou, adicione uma segunda linha que associe outro campo (por exemplo, Drimify_Game__c) à Referência da aplicação.

Disponível nos espaços de trabalho

Na parte inferior do formulário de integração, a secção Disponível nos espaços de trabalho permite definir quais os espaços de trabalho que podem utilizar a integração, através do interruptor junto a cada um.
Clique em Selecionar todos para ativar a integração em todos os espaços de trabalho de uma só vez.

Guardar e gerir integrações

Depois de preencher todos os campos, clique em Guardar alterações para criar a integração. Esta aparecerá na lista principal de integrações. Pode editar ou eliminar as integrações existentes a partir desta lista a qualquer momento. Clique em Cancelar para descartar as alterações não guardadas.

Integrações de e-mail

As integrações de e-mail permitem enviar e-mails transacionais (por exemplo, confirmações, resultados ou mensagens de acompanhamento) diretamente a partir das suas experiências Drimify, através do seu fornecedor de e-mail preferido.

Adicionar uma integração de remetente

1. Aceda a Integrações → Integrações de remetente
2. Clique em Adicionar integração de remetente
3. Selecione o seu fornecedor:

• Amazon SES
• Brevo
• Drimify
• Mailgun
• Mailjet
• Mandrill
• SendGrid
• Tipimail
• SMTP personalizado

Configurar a sua integração de remetente

Definições gerais

Todos os fornecedores têm as seguintes definições gerais em comum:

• Nome da integração – Nome interno para identificar a sua integração
• Nome do remetente – Nome apresentado como remetente do e-mail
• E-mail do remetente – Endereço de e-mail utilizado para enviar e-mails (não se aplica à Drimify — consulte a secção abaixo)
• E-mail em BCC (opcional) – Adicione um endereço de e-mail para receber uma cópia oculta de todos os e-mails enviados

Autenticação

Cada fornecedor requer credenciais específicas. Consulte a secção de configuração do respetivo fornecedor abaixo para obter mais informações.

Testar a ligação

Depois de introduzir as suas credenciais, clique em Enviar e-mail de teste para verificar se a integração está a funcionar corretamente. Se a ligação for válida, aparecerá a mensagem de confirmação «E-mail de teste enviado com sucesso».

Campos de parâmetros do modelo

Mapeie os campos de dados da Drimify para as variáveis dos modelos do seu fornecedor de e-mail. Esta secção está disponível para os fornecedores que suportam modelos de e-mail dinâmicos: Brevo, Mailgun, Mailjet, Mandrill, SendGrid e Tipimail.

• Nome do parâmetro – Nome da variável utilizada no seu modelo de e-mail
• Campo – Dados correspondentes da Drimify (por exemplo, Nome, E-mail, Pontuação, etc.)

Clique em Adicionar campo para criar mapeamentos adicionais.

Disponível nos espaços de trabalho

Selecione os espaços de trabalho que podem utilizar esta integração de remetente.

Configuração por fornecedor

Amazon SES

O que é necessário:

• Um utilizador do AWS IAM com permissões ses:SendEmail
• Chave de acesso à API e chave privada da API (obtidas no AWS IAM)
• A sua região AWS (por exemplo, eu-west-1, us-east-1)
• Token de sessão (apenas se utilizar credenciais temporárias/STS)
• Um endereço de e-mail de remetente ou domínio verificado no Amazon SES

Passos:

1. No AWS IAM, crie um utilizador com permissões de envio SES e gere um par de chaves de acesso
2. Na Drimify, introduza a Chave de acesso à API, a Chave privada da API e a Região
3. Se utilizar credenciais temporárias, introduza também o Token de sessão
4. Certifique-se de que o endereço de e-mail do remetente ou o domínio está verificado no Amazon SES
5. Clique em Enviar e-mail de teste para validar a ligação
6. Guarde a integração

Brevo

O que é necessário:

• Uma chave de API da Brevo

Passos:

1. Na sua conta Brevo, gere uma chave de API em Definições → Chaves de API
2. Cole-a no campo Chave de API na Drimify
3. Clique em Enviar e-mail de teste para validar a ligação
4. Guarde a integração

Drimify

Não requer autenticação. Os e-mails são enviados através da infraestrutura interna de e-mail da Drimify (notification@digitaservice.com).
O que é necessário:

• Um nome de remetente
• Um endereço de e-mail para resposta (por exemplo, contact@yourcompany.com)
• Opcionalmente, um endereço de e-mail para receber cópias ocultas (BCC)

Passos:

1. Selecione Drimify como fornecedor
2. Introduza o Nome do remetente e o E-mail para resposta
3. Se pretender, adicione um E-mail em BCC
4. Selecione os espaços de trabalho que devem utilizar esta integração e guarde-a

Mailgun

O que é necessário:

• Uma chave de API do Mailgun
• O seu domínio de envio registado no Mailgun
• A sua região da API (US ou EU)

Passos:

1. Na sua conta Mailgun, obtenha a chave de API e o domínio de envio
2. Na Drimify, introduza a Chave de API, o Domínio da API e a Região da API
3. Clique em Enviar e-mail de teste para validar a ligação
4. Guarde a integração

Mailjet

O que é necessário:

• Uma chave de acesso à API e uma chave privada da API do Mailjet

Passos:

1. Na sua conta Mailjet, aceda a Definições da conta → API REST → Gestão de chaves de API
2. Copie a Chave de acesso à API e a Chave privada da API
3. Introduza ambas na Drimify
4. Clique em Enviar e-mail de teste para validar a ligação
5. Guarde a integração

Mandrill

O que é necessário:

• Uma chave de API do Mandrill (o Mandrill é um módulo adicional do Mailchimp para o envio de e-mails transacionais)

Passos:

1. Na sua conta Mandrill, aceda a Definições → Chaves de API e gere uma chave
2. Cole a Chave de API na Drimify
3. Clique em Enviar e-mail de teste para validar a ligação
4. Guarde a integração

SendGrid

O que é necessário:

• Uma chave de API do SendGrid com permissões de envio de e-mail

Passos:

1. Na sua conta SendGrid, aceda a Definições → Chaves de API e crie uma chave com permissões de Envio de e-mail
2. Cole a Chave de API na Drimify
3. Clique em Enviar e-mail de teste para validar a ligação
4. Guarde a integração

Tipimail

O que é necessário:

• Um utilizador da API e uma chave de API do Tipimail (o Tipimail é o serviço de e-mail transacional da Sarbacane)

Passos:

1. Na sua conta Tipimail, aceda a Definições → SMTP e APIs e obtenha o Utilizador da API e a Chave de API
2. Introduza ambos na Drimify
3. Clique em Enviar e-mail de teste para validar a ligação
4. Guarde a integração

SMTP personalizado

O que é necessário:

• O nome do servidor SMTP
• A porta SMTP (normalmente 587 para TLS ou 465 para SSL)
• O nome de utilizador SMTP (geralmente o seu endereço de e-mail)
• A palavra-passe SMTP

Passos:

1. Obtenha as credenciais SMTP junto do seu fornecedor de alojamento de e-mail ou nas definições do servidor
2. Na Drimify, introduza o Servidor, a Porta, o Nome de utilizador e a Palavra-passe
3. Clique em Enviar e-mail de teste para validar a ligação
4. Guarde a integração

Actualizado em: 03/11/2026