Skip to main content

​
API de Workspaces

Gerencie workspaces WhatsApp Business. Todos os endpoints requerem autenticação via API key do Grwthy.

​
Criar Workspace

​
X-Api-Key
string
required
API key do Grwthy
POST https://grwthy.com/whatsapp/workspaces
Cria um novo workspace WhatsApp Business vinculado ao usuário da API key.

​
Corpo da Requisição

​
name
string
required
Nome de exibição do workspace. Usado apenas para identificação no Dashboard e nas respostas da API. Exemplo: "Atendimento", "Vendas", "Meu Negócio"
​
businessAccountId
string
required
Identificador numérico da conta WhatsApp Business (WABA). Encontrado em WhatsApp Business Platform → Configuração da API → WhatsApp Business Account ID. Exemplo: "987654321098765"
​
accessToken
string
required
Token de acesso permanente para autenticação com a API do WhatsApp. Gerado criando um System User em Configurações do Negócio → Usuários → Usuários do sistema e atribuindo permissões de whatsapp_business_messaging. Armazenado de forma segura e criptografado (AES-256-GCM). Nunca exposto nas respostas da API.
​
appSecret
string
required
Chave secreta da aplicação, usada pelo Grwthy para verificar a assinatura dos eventos recebidos via webhook. Encontrado em Painel da App → Configurações → Básico → Chave Secreta do Aplicativo. Armazenado de forma segura e criptografado (AES-256-GCM). Nunca exposto nas respostas da API.
​
apiKey
string
required
Chave da API do WhatsApp Business. Encontrada em Painel da App → Configurações → Básico → Identificador do Aplicativo. Armazenada de forma segura e criptografada (AES-256-GCM). Nunca exposta nas respostas da API.
​
webhookVerifyToken
string
required
Token personalizado definido por você, usado para validar a verificação do endpoint de webhook. Pode ser qualquer string — recomendamos usar um UUID ou valor aleatório seguro. Exemplo: "meu-token-secreto-123"
Os campos accessToken, appSecret e apiKey são credenciais para integração com a API do WhatsApp. Eles são diferentes da API key do Grwthy usada no header X-Api-Key. Veja Autenticação para mais detalhes.

​
Resposta

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "auth0|123456789",
  "name": "Meu Negócio",
  "businessAccountId": "987654321098765",
  "webhookVerifyToken": "meu-token-de-verificacao",
  "isActive": true,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

​
Erros

StatusDescrição
409Business Account ID já registrado

​
Listar Workspaces

GET https://grwthy.com/whatsapp/workspaces
Retorna os workspaces do usuário autenticado. Campos sensíveis (accessToken, appSecret, apiKey) nunca são incluídos na resposta.

​
Resposta

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "userId": "auth0|123456789",
    "name": "Meu Negócio",
    "businessAccountId": "987654321098765",
    "webhookVerifyToken": "meu-token-de-verificacao",
    "isActive": true,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  }
]

​
Buscar Workspace

GET https://grwthy.com/whatsapp/workspaces/:id
​
id
string
required
UUID do workspace

​
Erros

StatusDescrição
404Workspace não encontrado

​
Atualizar Workspace

PATCH https://grwthy.com/whatsapp/workspaces/:id
​
id
string
required
UUID do workspace
Todos os campos são opcionais. Apenas os campos fornecidos são atualizados.

​
Corpo da Requisição

​
name
string
Nome de exibição atualizado
​
accessToken
string
Novo access token
​
appSecret
string
Novo app secret
​
apiKey
string
Nova API key
​
webhookVerifyToken
string
Novo token de verificação do webhook
​
isActive
boolean
Ativar ou desativar o workspace

​
Resposta

Retorna o objeto do workspace atualizado.

​
Desativar Workspace

DELETE https://grwthy.com/whatsapp/workspaces/:id
​
id
string
required
UUID do workspace
Desativa o workspace. Ele não poderá mais enviar ou receber mensagens.

​
Resposta

{
  "message": "Workspace deactivated"
}

​
Buscar Phone Numbers do Workspace

GET https://grwthy.com/whatsapp/workspaces/:id/phone-numbers
​
id
string
required
UUID do workspace
Retorna os phone numbers associados ao workspace.

​
Resposta

{
  "data": [
    {
      "verified_name": "Meu Negócio",
      "display_phone_number": "+55 11 99999-9999",
      "id": "123456789012345",
      "quality_rating": "GREEN"
    }
  ]
}

​
Buscar Templates do Workspace

GET https://grwthy.com/whatsapp/workspaces/:id/templates
​
id
string
required
UUID do workspace
​
limit
integer
default:"100"
Número máximo de templates a retornar
Retorna os templates de mensagem disponíveis para este workspace. Veja API de Templates para o formato da resposta.