Skip to main content

​
O que é um workspace?

Um workspace é o container onde ficam todos os recursos da sua conta na Notifique. É o “espaço de trabalho” que agrupa instâncias WhatsApp, números SMS, domínios de e-mail, apps de push, webhooks, API Keys e o histórico de mensagens e envios. Pense no workspace como o projeto ou ambiente em que você opera: cada workspace tem seu próprio plano, créditos, limites e configurações. Um mesmo usuário pode ter vários workspaces (por exemplo, um para produção e outro para testes, ou um por marca/cliente).

​
Para que serve?

  • Organizar recursos — Instâncias, números, domínios e webhooks pertencem a um workspace. Tudo que você faz via API ou dashboard está sempre no contexto de um workspace (identificado pelo header x-workspace-id ou pelo workspace da API Key).
  • Plano, créditos e saldo — O plano (Free, Basic, Pro, Business) e os créditos mensais são por workspace. Além disso, existe a opção Pague pelo uso: um saldo em reais (carteira) que você recarrega. Quem está em plano pago e acaba os créditos daquele mês passa a usar esse saldo até a próxima renovação.
  • Equipe e permissões — Você pode convidar membros para um workspace e gerenciar acessos. API Keys são criadas por workspace e podem ter escopos diferentes (por exemplo, uma key só para leitura de logs, outra para envio de mensagens).
  • Configurações padrão e de recebimento — No workspace você define instância WhatsApp padrão, domínio de e-mail padrão e preferências de recebimento (inbound) por canal, que controlam o que pode ser persistido como mensagem recebida.
  • Recursos experimentais — É possível ativar recursos de grupos WhatsApp (enviar mensagens para grupos por JID, listar grupos, adicionar/remover participantes, enviar/revogar link de convite, buscar código). Eles ficam disponíveis em Settings → Recursos experimentais e exigem aceite explícito.

​
Configurações de inbound por workspace

Cada workspace possui uma política de inbound (inboundSettings) para controlar recebimento por canal:
  • SMS: enabled (liga/desliga persistência de inbound SMS).
  • WhatsApp: enabled, allowPrivateChats e allowGroupChats.
  • E-mail: enabled (reserva para pipeline de inbound e-mail).

​
Regras importantes (WhatsApp)

  • Se whatsapp.enabled = false, nenhuma inbound de WhatsApp é persistida.
  • Se allowPrivateChats = false, inbounds de conversas privadas são ignoradas.
  • Para grupos, além de allowGroupChats = true, o workspace também precisa ter groupFeaturesEnabled = true (defesa em profundidade).
Quando inboundSettings não foi configurado, o comportamento padrão é legado: tudo habilitado.

​
Workspace e API

Cada API Key está vinculada a um workspace. Ao usar a API, todas as operações (mensagens, SMS, e-mail, push, webhooks, etc.) ocorrem nesse workspace. Se você precisar de ambientes separados (produção/staging, ou um workspace por cliente), crie um workspace para cada um e use API Keys distintas. Na documentação Quick Start desta seção você encontra os endpoints para criar, editar e deletar workspaces via API, sempre respeitando o limite de workspaces por usuário e as permissões da API Key.