Slack

Introdução

A integração com o Slack publica eventos do Dodo Payments, como pagamentos bem-sucedidos, alterações de assinatura e contestações, em um canal do Slack que você escolher. Sua equipe pode acompanhar pagamentos e agir sobre contestações pelo Slack, sem precisar verificar o dashboard.

O conector do Slack transforma cada evento do Dodo Payments em uma mensagem do Slack por meio de uma transformação: código JavaScript executado no evento antes da entrega. O conector já vem com código de transformação, portanto não é necessário programar para começar. Você precisa ter acesso a Developer → Webhooks no dashboard do Dodo Payments e permissão para adicionar apps ao seu workspace do Slack.

Começando

Open the Webhook Section

No dashboard do Dodo Payments, acesse Desenvolvedor → Webhooks e clique em Adicionar endpoint.

Caixa de diálogo Adicionar endpoint com o menu suspenso Integração definido como webhook personalizado

Select Slack Integration

Em Integração, selecione Slack. O dashboard carrega o código de transformação do Slack e exibe as etapas de configuração no painel Como conectar o Slack.

Caixa de diálogo Adicionar endpoint com o Slack selecionado e as etapas Como conectar o Slack

Create a Slack Webhook URL

No Slack, crie um app com um webhook de entrada para o canal que deve receber as notificações:

Abra api.slack.com/apps, clique em Create New App e escolha From scratch.
Dê um nome ao app, por exemplo Dodo Payments Notifications, selecione seu workspace e clique em Create App.
Na barra lateral, abra Incoming Webhooks e ative Activate Incoming Webhooks.
Clique em Add New Webhook to Workspace, escolha o canal e clique em Allow.
Copie a Webhook URL, que começa com https://hooks.slack.com/services/.

Tela de permissões do Slack com um seletor de canal e um botão Allow

Paste the Webhook URL

Cole a URL do webhook do Slack em Endpoint URL. O Slack não precisa de uma chave de API.

Select Events

Subscribed events lista os eventos compatíveis com o conector do Slack. Se você alterar a transformação, mantenha apenas os eventos que ela trata. O Slack rejeita uma solicitação que não seja uma mensagem do Slack; portanto, um evento que a transformação deixa inalterado não é entregue.

Customize Transformation Code

Em Transformation code, edite o handler para escolher quais eventos publicam uma mensagem e como cada mensagem será exibida. Mantenha o código do conector ou comece pelos exemplos.

Editor de código de transformação com o handler do Slack para eventos de pagamento

Test and Create

Em Testar este código, selecione um tipo de evento e clique em Simular. O Resultado mostra a mensagem que o Slack receberia. Em seguida, clique em Criar endpoint.

Painel Testar este código com payment.succeeded selecionado, um botão Simular e o botão Criar endpoint

Integration Complete!

O Dodo Payments agora publica cada evento inscrito no seu canal do Slack. Para publicar uma mensagem de teste, abra a guia Testing do endpoint, selecione um tipo de evento e clique em Send example.

Exemplos de código de transformação

Cada handler substitui webhook.payload por uma mensagem do Slack e mantém webhook.url, sua URL de webhook de entrada. Os valores do Dodo Payments estão na menor unidade da moeda, portanto os exemplos dividem por 100 e exibem o código da moeda. Para moedas sem casas decimais, como JPY e KRW, use o valor como está.

Notificações básicas de pagamento

Publique uma mensagem de texto simples quando um pagamento for bem-sucedido, falhar ou estiver sendo processado:

payment_notifs.js

function handler(webhook) {
  switch (webhook.eventType) {
    case "payment.succeeded":
      webhook.payload = {
        text: `✅ Payment Successful\nAmount: ${(webhook.payload.data.total_amount / 100).toFixed(2)} ${webhook.payload.data.currency}\nCustomer: ${webhook.payload.data.customer.email}\nPayment ID: ${webhook.payload.data.payment_id}`
      };
      break;
      
    case "payment.failed":
      webhook.payload = {
        text: `❌ Payment Failed\nAmount: ${(webhook.payload.data.total_amount / 100).toFixed(2)} ${webhook.payload.data.currency}\nCustomer: ${webhook.payload.data.customer.email}\nReason: ${webhook.payload.data.error_message || 'Unknown'}`
      };
      break;
      
    case "payment.processing":
      webhook.payload = {
        text: `⏳ Payment Processing\nAmount: ${(webhook.payload.data.total_amount / 100).toFixed(2)} ${webhook.payload.data.currency}\nCustomer: ${webhook.payload.data.customer.email}`
      };
      break;
  }

  return webhook;
}

Notificações detalhadas de assinatura

Publique uma mensagem com código de cores e campos de anexo quando uma assinatura for ativada, cancelada ou renovada:

subscription_notifs.js

function handler(webhook) {
  switch (webhook.eventType) {
    case "subscription.active":
      webhook.payload = {
        attachments: [{
          color: "good",
          title: "🎉 Subscription Activated",
          fields: [
            {
              title: "Customer",
              value: webhook.payload.data.customer.email,
              short: true
            },
            {
              title: "Product ID",
              value: webhook.payload.data.product_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.recurring_pre_tax_amount / 100).toFixed(2)} ${webhook.payload.data.currency}/${webhook.payload.data.payment_frequency_interval}`,
              short: true
            },
            {
              title: "Next Billing",
              value: new Date(webhook.payload.data.next_billing_date).toLocaleDateString(),
              short: true
            }
          ],
          footer: "Dodo Payments",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
      
    case "subscription.cancelled":
      webhook.payload = {
        attachments: [{
          color: "warning",
          title: "⚠️ Subscription Cancelled",
          fields: [
            {
              title: "Customer",
              value: webhook.payload.data.customer.email,
              short: true
            },
            {
              title: "Product ID",
              value: webhook.payload.data.product_id,
              short: true
            },
            {
              title: "Cancellation Date",
              value: new Date(webhook.payload.data.cancelled_at).toLocaleDateString(),
              short: true
            },
            {
              title: "Cancel at Next Billing",
              value: webhook.payload.data.cancel_at_next_billing_date ? "Yes" : "No",
              short: true
            }
          ],
          footer: "Dodo Payments",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
      
    case "subscription.renewed":
      webhook.payload = {
        attachments: [{
          color: "good",
          title: "🔄 Subscription Renewed",
          fields: [
            {
              title: "Customer",
              value: webhook.payload.data.customer.email,
              short: true
            },
            {
              title: "Product ID",
              value: webhook.payload.data.product_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.recurring_pre_tax_amount / 100).toFixed(2)} ${webhook.payload.data.currency}`,
              short: true
            },
            {
              title: "Next Billing",
              value: new Date(webhook.payload.data.next_billing_date).toLocaleDateString(),
              short: true
            }
          ],
          footer: "Dodo Payments",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
  }

  return webhook;
}

Notificações de gerenciamento de contestações

Publique uma mensagem vermelha quando uma contestação for aberta ou perdida, e uma verde quando for ganha:

dispute_notifs.js

function handler(webhook) {
  switch (webhook.eventType) {
    case "dispute.opened":
      webhook.payload = {
        attachments: [{
          color: "danger",
          title: "🚨 New Dispute Opened",
          fields: [
            {
              title: "Payment ID",
              value: webhook.payload.data.payment_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.amount / 100).toFixed(2)} ${webhook.payload.data.currency}`,
              short: true
            },
            {
              title: "Status",
              value: webhook.payload.data.dispute_status,
              short: true
            },
            {
              title: "Stage",
              value: webhook.payload.data.dispute_stage,
              short: true
            },
            {
              title: "Remarks",
              value: webhook.payload.data.remarks || "No remarks",
              short: false
            }
          ],
          footer: "Dodo Payments - Action Required",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
      
    case "dispute.won":
      webhook.payload = {
        attachments: [{
          color: "good",
          title: "✅ Dispute Won",
          fields: [
            {
              title: "Payment ID",
              value: webhook.payload.data.payment_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.amount / 100).toFixed(2)} ${webhook.payload.data.currency}`,
              short: true
            },
            {
              title: "Status",
              value: webhook.payload.data.dispute_status,
              short: true
            },
            {
              title: "Resolution",
              value: "Dispute resolved in your favor",
              short: false
            }
          ],
          footer: "Dodo Payments",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
      
    case "dispute.lost":
      webhook.payload = {
        attachments: [{
          color: "danger",
          title: "❌ Dispute Lost",
          fields: [
            {
              title: "Payment ID",
              value: webhook.payload.data.payment_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.amount / 100).toFixed(2)} ${webhook.payload.data.currency}`,
              short: true
            },
            {
              title: "Status",
              value: webhook.payload.data.dispute_status,
              short: true
            },
            {
              title: "Impact",
              value: "The disputed amount stays deducted from your balance",
              short: false
            }
          ],
          footer: "Dodo Payments - Review Required",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
  }

  return webhook;
}

Handler abrangente para todos os eventos

Publique uma mensagem no mesmo formato para cada tipo de evento. Os eventos sem seu próprio case recebem uma mensagem genérica com o tipo e o horário do evento:

all_events_notifs.js

function handler(webhook) {
  const event = webhook.payload.data;
  const timestamp = new Date(webhook.payload.timestamp).toLocaleString();
  
  let color, emoji, title, fields = [];
  
  switch (webhook.eventType) {
    case "payment.succeeded":
      color = "good";
      emoji = "✅";
      title = "Payment Successful";
      fields = [
        { title: "Amount", value: `${(event.total_amount / 100).toFixed(2)} ${event.currency}`, short: true },
        { title: "Customer", value: event.customer.email, short: true },
        { title: "Payment ID", value: event.payment_id, short: true },
        { title: "Method", value: event.payment_method || "Unknown", short: true }
      ];
      break;
      
    case "payment.failed":
      color = "danger";
      emoji = "❌";
      title = "Payment Failed";
      fields = [
        { title: "Amount", value: `${(event.total_amount / 100).toFixed(2)} ${event.currency}`, short: true },
        { title: "Customer", value: event.customer.email, short: true },
        { title: "Reason", value: event.error_message || "Unknown", short: false }
      ];
      break;
      
    case "subscription.active":
      color = "good";
      emoji = "🎉";
      title = "Subscription Activated";
      fields = [
        { title: "Customer", value: event.customer.email, short: true },
        { title: "Product ID", value: event.product_id, short: true },
        { title: "Amount", value: `${(event.recurring_pre_tax_amount / 100).toFixed(2)} ${event.currency}/${event.payment_frequency_interval}`, short: true },
        { title: "Next Billing", value: new Date(event.next_billing_date).toLocaleDateString(), short: true }
      ];
      break;
      
    case "subscription.cancelled":
      color = "warning";
      emoji = "⚠️";
      title = "Subscription Cancelled";
      fields = [
        { title: "Customer", value: event.customer.email, short: true },
        { title: "Product ID", value: event.product_id, short: true },
        { title: "Cancellation Date", value: new Date(event.cancelled_at).toLocaleDateString(), short: true },
        { title: "Cancel at Next Billing", value: event.cancel_at_next_billing_date ? "Yes" : "No", short: true }
      ];
      break;
      
    case "refund.succeeded":
      color = "good";
      emoji = "💰";
      title = "Refund Processed";
      fields = [
        { title: "Amount", value: `${(event.amount / 100).toFixed(2)} ${event.currency || ""}`, short: true },
        { title: "Refund ID", value: event.refund_id, short: true },
        { title: "Payment ID", value: event.payment_id, short: true },
        { title: "Reason", value: event.reason || "Not specified", short: true }
      ];
      break;
      
    case "dispute.opened":
      color = "danger";
      emoji = "🚨";
      title = "New Dispute Opened";
      fields = [
        { title: "Payment ID", value: event.payment_id, short: true },
        { title: "Amount", value: `${(event.amount / 100).toFixed(2)} ${event.currency}`, short: true },
        { title: "Status", value: event.dispute_status, short: true },
        { title: "Stage", value: event.dispute_stage, short: true },
        { title: "Remarks", value: event.remarks || "No remarks", short: false }
      ];
      break;
      
    case "license_key.created":
      color = "good";
      emoji = "🔑";
      title = "License Key Created";
      fields = [
        { title: "License ID", value: event.id, short: true },
        { title: "Product ID", value: event.product_id, short: true },
        { title: "License Key", value: event.key.substring(0, 8) + "****", short: true },
        { title: "Expires", value: event.expires_at ? new Date(event.expires_at).toLocaleDateString() : "Never", short: true }
      ];
      break;
      
    default:
      // Handle any other events with a generic format
      color = "#3aa3e3";
      emoji = "ℹ️";
      title = webhook.eventType.replace(/_/g, ' ').replace(/\b\w/g, l => l.toUpperCase());
      fields = [
        { title: "Event Type", value: webhook.eventType, short: true },
        { title: "Timestamp", value: timestamp, short: true }
      ];
  }
  
  webhook.payload = {
    attachments: [{
      color: color,
      title: `${emoji} ${title}`,
      fields: fields,
      footer: "Dodo Payments",
      ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
    }]
  };

  return webhook;
}

Práticas recomendadas

Siga estas práticas para manter as notificações do Slack úteis:

Use anexos de mensagem com cores e campos para que cada evento seja claro e fácil de utilizar.
Inclua dados importantes, como o valor, o e-mail do cliente e os IDs, para que sua equipe encontre o registro rapidamente.
Combine a cor com o tipo de evento: verde (good) para sucesso, vermelho (danger) para contestações ou falhas, amarelo (warning) para cancelamentos e azul (#3aa3e3) para eventos informativos.
Adicione um registro de data e hora (ts) para que cada mensagem mostre quando o evento ocorreu.

Lide com dados confidenciais: não publique valores confidenciais, como chaves de licença completas ou dados pessoais, no Slack. Trunque-os ou oculte-os, como faz o campo de chave de licença no exemplo de todos os eventos.

Solução de problemas

Notifications Not Appearing in Slack

Verifique se a URL do webhook do Slack está correta e se o aplicativo do Slack ainda está instalado.
Verifique se o código de transformação é um JavaScript válido.
Verifique se os eventos inscritos estão ocorrendo. Para enviar um, use Enviar exemplo na aba Testes do endpoint.
Verifique se o aplicativo do Slack tem Webhooks de entrada ativado e consegue publicar no canal.

Transformation Errors

Abra a aba Registros em Desenvolvedor → Webhooks e verifique a resposta da entrega com falha.
Verifique se os campos do payload lidos pelo seu código correspondem ao payload do evento desse tipo de evento.
Teste seu código com Simular e um payload de exemplo.
Verifique se cada campo lido pelo seu código está presente. Campos opcionais, como error_message, podem ser null.

Missing Event Types

Verifique se o evento está selecionado em Eventos inscritos. Para alterar a seleção, abra o endpoint e clique em Editar.
Verifique se o conector do Slack é compatível com o evento. Eventos inscritos lista apenas os eventos compatíveis com o conector.
Verifique se sua transformação tem um case para o evento. Os exemplos deixam os outros eventos inalterados, e o Slack os rejeita.

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

Introdução

Começando

Exemplos de código de transformação

Notificações básicas de pagamento

Notificações detalhadas de assinatura

Notificações de gerenciamento de contestações

Handler abrangente para todos os eventos

Práticas recomendadas

Solução de problemas

​Introdução

​Começando

​Exemplos de código de transformação

​Notificações básicas de pagamento

​Notificações detalhadas de assinatura

​Notificações de gerenciamento de contestações

​Handler abrangente para todos os eventos

​Práticas recomendadas

​Solução de problemas

Introdução

Começando

Exemplos de código de transformação

Notificações básicas de pagamento

Notificações detalhadas de assinatura

Notificações de gerenciamento de contestações

Handler abrangente para todos os eventos

Práticas recomendadas

Solução de problemas