Este artigo também está disponível em:

Configuração de Integrações de Webhook na Drimify

Configurando Integrações no Drimify (Webhooks & Mailers)


As integrações do Drimify permitem que você envie automaticamente dados dos participantes para serviços externos sempre que um utilizador interage com a sua aplicação. Pode conectar-se a uma API Personalizada, HubSpot ou Salesforce — e para cada integração, pode especificar exatamente quais campos de dados são transmitidos.


Primeiros Passos


Vá para Minha Conta → Integrações.


Se nenhuma integração tiver sido configurada ainda, verá a tela de espaço reservado "Sem integrações de webhook ainda" ou "Sem integrações de e-mail ainda". Clique em + Adicionar Nova Integração (disponível tanto no canto superior direito quanto no centro da página) para abrir o seletor de integração.


Integrações De Webhook


Selecionando um Tipo de Integração


Abrirá uma janela modal intitulada "Selecionar Integração Webhook".
Pode filtrar por categoria usando o menu suspenso (padrão é Todas). As três integrações disponíveis são:


  • API Personalizada — para qualquer endpoint REST da api sob seu controle
  • HubSpot — para automação de CRM & Marketing através do HubSpot
  • Salesforce — para CRM do Salesforce


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


Integração de API Personalizada


Autenticação


Após selecionar Custom API, o painel Adicionar Integração abre com os seguintes campos:


  • Nome da Integração: Um rótulo para sua própria referência (padrão: "Custom API Integration"). Pode renomeá-lo para algo mais descritivo.
  • Endpoint da API: A URL completa do seu receptor de webhook (por exemplo: https://api.example.com/webhook). Este deve ser um endpoint HTTPS.
  • Método HTTP:


Selecione o método HTTP usado para enviar a solicitação do webhook para seu endpoint. Opções disponíveis:


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


Escolha o método que corresponde à forma como sua API espera receber os dados.


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


Opção

Descrição

Nenhum

Nenhum cabeçalho de autenticação é enviado

chave api (X-API-KEY)

Envia a chave em um cabeçalho X-API-KEY

Bearer Token

Envia a chave como Authorization: Bearer <token>

Basic Autenticação

Envia um cabeçalho Authorization: Basic gerado a partir do seu Login e Senha

Cabeçalho Personalizado

Permite que defina seu próprio nome de cabeçalho (por exemplo, X-Custom-Auth)


  • Quando Autenticação Básica é selecionada, dois campos aparecem: Login (nome de utilizador) e Password. Insira-os como estão — o Drimify cria automaticamente o cabeçalho Authorization: Basic para você. Não precisa codificar nada por conta própria.
  • Quando Cabeçalho Personalizado é selecionado, um campo adicional Nome do Cabeçalho Personalizado aparece, onde pode inserir o nome da chave do cabeçalho.
  • Chave da API: O valor secreto enviado usando o método de autenticação selecionado.
  • Verificar Conexão: Clique neste botão para testar se o Drimify consegue atingir com sucesso seu endpoint usando as credenciais fornecidas antes de salvar.


Recuperando o token de um endpoint de autenticação (pré-chamada)


Algumas APIs requerem que autentique primeiro: chama um endpoint de autenticação com suas credenciais, recebe um token e usa esse token na chamada do webhook real. O Drimify suporta isso automaticamente.


Quando o tipo de Autenticação é API Key, Bearer Token ou Cabeçalho Personalizado, uma caixa de seleção "Obter este token de um endpoint de autenticação" aparece. Quando marcada, o campo de credencial estático é substituído pelas configurações de pré-chamada abaixo (para Cabeçalho Personalizado, o campo de nome do cabeçalho permanece visível — o token obtido é enviado nesse cabeçalho).


O token obtido é colocado conforme seu tipo de Autenticação:


  • Bearer Token → Authorization: Bearer <token>
  • chave api → X-API-KEY: <token>
  • Cabeçalho Personalizado → <seu nome de cabeçalho>: <token>


Escolher um de três métodos


OAuth2 (client_credentials) — para servidores padrão OAuth2 (ex. Keycloak).


  • Campos: Token URL, Client ID, Client Secret, Scope (opcional)
  • O Drimify envia um pedido padrão OAuth2 client_credentials e lê o token de access_token. A duração do token é obtida do expires_in do servidor.


Login JSON — para endpoints de login que aceitam um corpo JSON e retornam um token.


  • Campos: Auth URL, Body (lista de chave/valor), Token path
  • O Drimify envia um POST com um corpo JSON feito a partir das suas linhas chave/valor (ex. linhas email = a@b.com e password = secret produzem {"email":"a@b.com","password":"secret"}).
  • Token path indica ao Drimify onde o token está na resposta JSON, usando a notação de pontos — ex. data.access_token, ou apenas token se estiver no nível superior.


Customizado — para qualquer caso que não se encaixe nos dois métodos acima.


  • Campos: Auth URL, Método HTTP (POST ou GET), Headers (lista de chave/valor), Body (lista de chave/valor), Codificação do corpo (JSON ou form-urlencoded), Token path
  • Com o método GET, não há corpo de pedido — passe os parâmetros via Headers ou Auth URL.
  • Se adicionar um cabeçalho Content-Type, ele prevalece sobre o implicado pela codificação do corpo.


Listas de chave/valor (Body e Headers)


Cada linha tem uma chave, um valor, e uma checkbox "sensível" (marcada por padrão). As linhas podem ser adicionadas e removidas, mas não editadas no local — para alterar uma linha, remova-a e adicione-a novamente. A flag sensível só pode ser configurada ao adicionar uma linha. Valores sensíveis são mascarados após serem salvos e nunca são expostos novamente, no formulário ou nos registros.


Cache de tokens e tentativas


  • Tokens OAuth2 são armazenados em cache pela duração indicada por expires_in.
  • Para Login JSON e Customizado, configure Validade do Token (minutos) — o padrão é 60 minutos se deixado vazio.
  • Tokens em cache são mantidos por um máximo de 7 dias.
  • Se o seu endpoint retornar 401 enquanto um token em cache estiver em uso, o Drimify descarta o token, re-autentica e tenta novamente a chamada.
  • Se a pré-chamada falhar (erro, timeout, ou token não encontrado no Token path), o webhook não é enviado sem autenticação — a entrega falha, é registrada e é tentada novamente pela fila de entrega como de costume.


Verificar Conexão com uma pré-chamada


O botão Verificar Conexão suporta totalmente a pré-chamada: autentica-se primeiro no seu endpoint de autenticação e depois executa a chamada de teste com o token obtido.


Integração HubSpot


Após selecionar HubSpot, o painel exibe:

  • Nome da Integração: Padrão: "Integração HubSpot".
  • API Key / Access Token: Cole aqui o seu Token de Aplicação Privada do HubSpot. O HubSpot descontinuou as chaves de API legadas em 2022, então deve usar um token de aplicação privada gerado a partir da sua conta HubSpot em: Configurações → Integrações → Aplicações Privadas
  • Verificar Conexão: Testa o token na API do HubSpot antes de salvar.


Integração Salesforce


Após selecionar Salesforce, o painel exibe:


  • Nome da Integração: Padrão: "Integração Salesforce".
  • Domínio Salesforce: A URL da sua instância Salesforce (por exemplo: yourcompany.my.salesforce.com).
  • Consumer Key e Consumer Secret: Obtidos de uma Aplicação Conectada configurada no Salesforce em: Configuração → Gerenciador de Aplicativos → Novo App Conectado. O Drimify usa o fluxo OAuth 2.0 Client Credentials.
  • Nome do Campo de ID Externo: O nome API do campo usado para correspondência (upsert) de registros — tipicamente algo como Email_External_Id__c ou um campo de id externo customizado nos objetos Contato ou Lead. Este campo deve estar marcado como um External ID no Salesforce.
  • Fonte do ID Externo: Um dropdown permitindo selecionar qual campo de dados do Drimify deve ser usado como a chave de correspondência (por exemplo: Email).
  • Verificar Conexão: Testa a conexão OAuth do Salesforce antes de salvar.


⚠️ Campos Obrigatórios Salesforce


O Salesforce impõe campos obrigatórios a nível de objeto. Se estiver a inserir ou atualizar Conduz, o Salesforce exige pelo menos:


  • lastName — obrigatório para criar um Lead


Se estiver a inserir ou atualizar Contacts, o Salesforce exige:


  • lastName — obrigatório para criar um Contacto


Embora o Email não seja obrigatório segundo o esquema padrão do Salesforce, ele é quase sempre necessário como uma ID Externa para corresponder e desduplicar registos corretamente durante as operações de inserção/atualização. Sem uma correspondência confiável de ID Externa, o Salesforce pode criar registos duplicados ou retornar um erro.


Melhores Práticas

Por favor, mapeie pelo menos:


  • Apelido
  • Email


ao conectar-se ao Salesforce. A omissão do Apelido fará com que o webhook falhe e o registo não será criado ou atualizado.


Mapeamento de Campos


Disponível para todos os três tipos de integração, o Map Fields permite especificar exatamente quais campos de dados Drimify são enviados para a sua integração, e sob quais nomes de chave.
Clique em + Adicionar Campo para adicionar uma linha de mapeamento.


Cada linha consiste de:


  • Campo do Webhook (esquerda) — o nome da chave que aparecerá na carga de saída (definido por si para corresponder aos requisitos da sua integração)
  • → Campo Fonte (dropdown à direita) — a fonte do valor para este campo. Pode:
    • Selecionar um campo de dados Drimify (por exemplo, Referência Do Aplicação, Email, Score) para enviar um valor dinâmico recolhido do participante
    • Selecionar Valor Estático para enviar um valor fixo e codificado sempre que o webhook for acionado — um campo de texto adicional aparecerá onde pode introduzir o valor (por exemplo, Meu_Valor). Útil para passar constantes como um nome de evento, um identificador de fonte ou uma etiqueta de ambiente.


Campos Fonte Drimify Disponíveis


Nome de Exibição

Chave do Campo

Endereço Postal

address

id do aplicação

appId

Referência Do Aplicação

appReference

Código

code

Nome Da Empresa

companyName

País Da Conexão

connectionCountry

País

country

Código Do País

countryCode

Caixa De Seleção Personalizada

customCheckbox

Formato Personalizado

customFormat

Campo De Texto Personalizado

customText

Data

date

Dados de Nascimento

dob

Data Com Fuso Horário

dateWithTimezone

Email

email

Nome

firstName

Gênero

gender

ID

id

Idunic

idunic

Endereço IP

ipAddress

Apelido

lastName

Níveis Jogados

levelsPlayed

Idioma Local

locale

Aceitação de Newsletter

optinNewsletter

Número De Telefone

phoneNumber

Jogados

played

Código Postal

cp

Perfil

profil

UID do Perfil

profilUid

Referência Do Prêmio

prizeRef

Título Do Prêmio

prizeTitle

UID do Prêmio

prizeUid

Indicação

referral

Pontuação

score

Selecionar Valor

selectValue

Selecionar Valor 2

selectValue2

ID da Sessão

sessionId

Tempo Gasto

timeTaken

Cidade

town

Atualizado Em

updatedAt

Atualizado Em Timestamp

updatedAtTimeStamp

Usuário

username

Endereço do Site

website


Pode adicionar quantos mapeamentos forem necessários.
Para remover um mapeamento, clique no ícone da lixeira à direita da linha.


Disponível em Espaços de Trabalho


Na parte inferior do formulário de integração, a seção Available in Workspaces permite usar o alternador seguinte para cada espaço de trabalho para controlar qual espaço de trabalho pode usar a integração.
Clique em Selecionar Tudo para ativar a integração para todos os espaços de trabalho de uma só vez.


Salvar e Gerir Integrações


Assim que todos os campos estiverem completos, clique em Salvar Alterações para criar a integração. A integração então aparecerá na lista principal de Integrações. Pode editar ou excluir as integrações existentes desta lista a qualquer momento. Clique em Cancelar para descartar alterações não salvas.



Integrações de E-Mail


As integrações de e-mail permitem que envie e-mails transacionais (por exemplo, confirmações, resultados ou acompanhamentos) diretamente das suas experiências Drimify usando o seu fornecedor de e-mail preferido.


Adicionar Integração de Remetente


  1. Aceder a Integrações → Integrações de Remetente
  2. Clicar em Adicionar Integração de Remetente
  3. Selecionar o seu provedor:
  • Amazon SES
  • Brevo
  • Drimify
  • Mailgun
  • Mailjet
  • Mandrill
  • SendGrid
  • Tipimail
  • SMTP Personalizado


Configurar a sua Integração de Remetente


Configurações Gerais


Todos os provedores partilham as seguintes configurações gerais:


  • Nome da Integração – Nome interno para identificar a sua integração
  • Nome do Remetente – Nome exibido como o remetente do email
  • Email do Remetente – Endereço de e-mail usado para enviar e-mails (não aplicável para Drimify — ver abaixo)
  • Email BCC (opcional) – Adicionar um endereço de e-mail para receber uma cópia de todos os e-mails enviados


Autenticação


Cada provedor requer credenciais específicas. Consulte a secção específica de configuração do provedor abaixo para mais detalhes.


Testar a Sua Conexão


Depois de inserir as suas credenciais, clique em Enviar Email de Teste para verificar se a sua integração está a funcionar corretamente. Aparecerá uma confirmação "Email de teste enviado com sucesso" se a conexão for válida.


⚠️ A integração deve passar no teste de conexão antes de poder ser usada. Se o teste for ignorado ou falhar, o remetente não estará disponível para uso nas suas experiências.


Campos de Parâmetros do Modelo


Mapear os campos de dados do Drimify para as variáveis do modelo do seu provedor de email. Esta secção está disponível para provedores que suportam modelos de email dinâmicos: Brevo, Mailgun, Mailjet, Mandrill, SendGrid, e Tipimail.


  • Nome do parâmetro – O nome da variável esperado no seu modelo de email
  • Campo – Os dados correspondentes do Drimify (ex. Nome, Email, Pontuação, etc.)


Clique em Adicionar Campo para criar mapeamentos adicionais.


💡 Isto permite-lhe personalizar e-mails de forma dinâmica usando os dados dos jogadores recolhidos na sua experiência.


Disponível em Espaços de Trabalho

Selecionar quais espaços de trabalho podem usar esta integração de remetente.


Configuração Específica do Provedor


Amazon SES


O que você precisa:


  • Um utilizador IAM da AWS com permissões ses:SendEmail
  • Chave de Acesso API e Chave Privada API (do IAM da AWS)
  • Sua região da AWS (por exemplo, eu-west-1, us-east-1)
  • Token de Sessão (apenas se estiver a usar credenciais temporárias/STS)
  • Um e-mail ou domínio do remetente verificado no Amazon SES


Passos:


  1. No IAM da AWS, crie um utilizador com permissões para enviar e-mails pelo SES e gere um par de chaves de acesso
  2. No Drimify, insira sua API Access Key, API Private Key e Region
  3. Se usar credenciais temporárias, insira também o Session Token
  4. Verifique se seu e-mail ou domínio do remetente está verificado no Amazon SES
  5. Clique em Send Test Email para validar a conexão
  6. Guarde sua integração


Brevo


O que você precisa:


  • Uma chave api do Brevo


Passos:


  1. Na sua conta Brevo, gere uma chave api em Settings → API Keys
  2. Cole-a no campo API Key no Drimify
  3. Clique em Send Test Email para validar a conexão
  4. Guarde sua integração


Drimify


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


  • Um nome do remetente
  • Um endereço de e-mail para resposta (ex. contact@yourcompany.com)
  • Opcionalmente, um endereço de e-mail BCC


Passos:


  1. Selecione Drimify como seu provedor
  2. Insira seu Sender Name e Reply-To Email
  3. Opcionalmente, adicione um BCC Email
  4. Selecione os espaços de trabalho que devem usar esta integração e guarde


💡 Use esta opção se não tiver um provedor de e-mail de terceiros ou quiser começar rapidamente sem qualquer configuração externa.


Mailgun


O que você precisa:


  • Uma chave api do Mailgun
  • Seu domínio de envio registado no Mailgun
  • Sua região de API (US ou EU)


Passos:


  1. Na sua conta Mailgun, recupere sua chave de api e domínio de envio
  2. No Drimify, insira sua API Key, API Domain e API Region
  3. Clique em Send Test Email para validar a conexão
  4. Guarde sua integração


Mailjet


O que você precisa:


  • Chave de Acesso API e Chave Privada API do Mailjet


Passos:


  1. Na sua conta Mailjet, vá para Account Configurações → REST API → chave api Management
  2. Copie sua API Access Key e API Private Key
  3. Insira ambas no Drimify
  4. Clique em Send Test Email para validar a conexão
  5. Guarde sua integração


Mandrill


O que você precisa:


  • Uma chave api do Mandrill (Mandrill é um complemento de e-mail transacional do Mailchimp)


Passos:


  1. Na sua conta Mandrill, vá para Settings → API Keys e gere uma chave
  2. Cole a API Key no Drimify
  3. Clique em Send Test Email para validar a conexão
  4. Guarde sua integração


SendGrid


O que você precisa:


  • Uma chave api do SendGrid com permissões de Enviar E-Mail


Passos:


  1. Na sua conta SendGrid, vá para Settings → API Keys e crie uma chave com permissões de Mail Send
  2. Cole a API Key no Drimify
  3. Clique em Send Test Email para validar a conexão
  4. Guarde sua integração


Tipimail


O que você precisa:


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


Passos:


  1. Na sua conta Tipimail, vá para Settings → SMTP & APIs e recupere seu API User e API Key
  2. Insira ambos no Drimify
  3. Clique em Send Test Email para validar a conexão
  4. Guarde sua integração


💡 O Tipimail suporta modelos de e-mail dinâmicos: refira-se ao seu modelo pelo nome e use a seção Campos De Parâmetros Do Modelo para mapear dados do Drimify para as variáveis do seu modelo.


SMTP Personalizado


O que você precisa:


  • O nome do seu servidor SMTP
  • Porta SMTP (normalmente 587 para TLS, 465 para SSL)
  • Login SMTP (geralmente seu endereço de e-mail)
  • Senha SMTP


Passos:


  1. Recupere suas credenciais SMTP do seu provedor de hospedagem de e-mail ou configuração de servidor
  2. No Drimify, insira seu Host, Port, Login e Password
  3. Clique em Send Test Email para validar a conexão
  4. Guarde sua integração

Actualizado em: 03/10/2026

Esse artigo foi útil?

Partilhe o seu feedback

Cancelar

Obrigado!