API Grapnel

• POST/links/{id}/duplicateDuplicar linklinks:write
• GET/linksListar linkslinks:read
• POST/linksCriar linklinks:write
• GET/links/check-slugVerificar disponibilidade do sluglinks:read
• GET/links/{id}Consultar link e configuraçãolinks:read
• PATCH/links/{id}Editar linklinks:write
• DELETE/links/{id}Mover link para a lixeiralinks:write
• POST/links/{id}/restoreRestaurar link da lixeiralinks:write

Pastas4

• GET/foldersListar pastaslinks:read
• POST/foldersCriar pastalinks:write
• PATCH/folders/{id}Editar pastalinks:write
• DELETE/folders/{id}Excluir pastalinks:write

Destinos4

• GET/links/{id}/destinationsListar destinos do linklinks:read
• POST/links/{id}/destinationsAdicionar destino ao linklinks:write
• PATCH/destinations/{id}Editar destinolinks:write
• DELETE/destinations/{id}Remover destinolinks:write

Mensagens dos links4

• GET/links/{id}/messagesListar mensagens do linklinks:read
• POST/links/{id}/messagesAdicionar mensagem ao linklinks:write
• PATCH/messages/{id}Editar mensagem do linklinks:write
• DELETE/messages/{id}Excluir mensagem do linklinks:write

Produtos4

• GET/links/{id}/productsListar produtos do linklinks:read
• POST/links/{id}/productsCriar produto no linklinks:write
• PATCH/products/{id}Editar produtolinks:write
• DELETE/products/{id}Remover produtolinks:write

Números2

• GET/instancesListar instâncias WhatsAppinstances:read
• GET/instances/{id}Consultar instânciainstances:read

Conexão3

• GET/instances/{id}/statusConsultar status da conexãowhatsapp:read
• POST/instances/{id}/connectConectar WhatsAppwhatsapp:write
• POST/instances/{id}/disconnectDesconectar WhatsAppwhatsapp:write

Envio4

• POST/instances/{id}/messages/textEnviar mensagem de textowhatsapp:write
• POST/instances/{id}/messages/contactEnviar cartão de contatowhatsapp:write
• POST/instances/{id}/messages/locationEnviar localizaçãowhatsapp:write
• POST/instances/{id}/messages/mediaEnviar imagem, vídeo, áudio ou documentowhatsapp:write

Conversas2

• GET/instances/{id}/chatsListar conversaschats:read
• GET/instances/{id}/chats/messagesConsultar mensagens de uma conversa individualchats:read

Grupos3

• GET/instances/{id}/groupsListar gruposwhatsapp:read
• POST/instances/{id}/groups/infoConsultar grupo pelo JIDwhatsapp:read
• GET/instances/{id}/groups/messagesConsultar mensagens de um grupowhatsapp:read

Assinatura

import { createHmac, timingSafeEqual } from "node:crypto";

// rawBody: o corpo exatamente como chegou, antes do JSON.parse.
export function isGrapnelEvent(rawBody: string, headers: Headers, secret: string) {
  const timestamp = headers.get("x-grapnel-timestamp") ?? "";
  const signature = headers.get("x-grapnel-signature") ?? "";
  if (Math.abs(Date.now() / 1000 - Number(timestamp)) > 300) return false;
  const expected = "sha256=" + createHmac("sha256", secret)
    .update(`${timestamp}.${rawBody}`, "utf8")
    .digest("hex");
  return signature.length === expected.length &&
    timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
}

Entregas

Evento

{
  "id": "01993fa0-1000-7000-8000-000000000001",
  "event": "whatsapp.message.received",
  "instance_id": "01993fa0-1000-7000-8000-000000000002",
  "message": {
    "messageid": "3EB0C767D26A1D1A2B3C",
    "chatid": "5511999999999@s.whatsapp.net",
    "senderName": "Ana Souza",
    "isGroup": false,
    "fromMe": false,
    "messageType": "conversation",
    "messageTimestamp": 1757851200000,
    "text": "Olá! Quero saber o prazo de entrega."
  }
}

Mensagens3

• GET/instances/{id}/messages/webhookConsultar webhook de mensagenswhatsapp:read
• POST/instances/{id}/messages/webhookConfigurar webhook de mensagenswhatsapp:write
• DELETE/instances/{id}/messages/webhookDesativar webhook de mensagenswhatsapp:write

Várias instâncias3

• GET/webhooks/messagesConsultar webhooks de mensagens de todas as instânciaswhatsapp:read
• POST/webhooks/messagesConfigurar webhook de mensagens em várias instânciaswhatsapp:write
• POST/webhooks/messages/disableDesativar webhook de mensagens em várias instânciaswhatsapp:write

Entregas1

• GET/instances/{id}/messages/webhook/deliveriesConsultar entregas do webhook de mensagenswhatsapp:read

Só grupos3

• GET/instances/{id}/groups/webhookConsultar webhook de mensagens dos gruposwhatsapp:read
• POST/instances/{id}/groups/webhookConfigurar webhook de mensagens dos gruposwhatsapp:write
• DELETE/instances/{id}/groups/webhookDesativar webhook de mensagens dos gruposwhatsapp:write

• GET/leadsListar contatos da contaleads:read
• GET/leads/statsConsultar estatísticas de contatosleads:read

• GET/instances/{id}/metricsConsultar métricas da instânciaanalytics:read
• GET/analyticsConsultar analytics da contaanalytics:read
• GET/links/{id}/analyticsConsultar analytics de um linkanalytics:read

• GET/logsConsultar logslogs:read

Mensagens21

• POST/instances/{id}/whatsapp/send/textEnviar mensagem de textowhatsapp:write
• POST/instances/{id}/whatsapp/send/mediaEnviar mídia (imagem, vídeo, áudio ou documento)whatsapp:write
• POST/instances/{id}/whatsapp/send/contactEnviar cartão de contato (vCard)whatsapp:write
• POST/instances/{id}/whatsapp/send/locationEnviar localização geográficawhatsapp:write
• POST/instances/{id}/whatsapp/message/presenceEnviar atualização de presençawhatsapp:write
• POST/instances/{id}/whatsapp/send/statusEnviar Stories (Status)whatsapp:write
• POST/instances/{id}/whatsapp/send/menuEnviar menu interativo (botões, carrosel, lista ou enquete)whatsapp:write
• POST/instances/{id}/whatsapp/send/carouselEnviar carrossel de mídia com botõeswhatsapp:write
• POST/instances/{id}/whatsapp/send/location-buttonSolicitar localização do usuáriowhatsapp:write
• POST/instances/{id}/whatsapp/send/request-paymentSolicitar pagamentowhatsapp:write
• POST/instances/{id}/whatsapp/send/pix-buttonEnviar botão PIXwhatsapp:write
• GET/instances/{id}/whatsapp/message/asyncConsultar fila async de envio diretowhatsapp:read
• DELETE/instances/{id}/whatsapp/message/asyncLimpar fila async de envio diretowhatsapp:write
• POST/instances/{id}/whatsapp/message/downloadBaixar arquivo de uma mensagemchats:read
• POST/instances/{id}/whatsapp/message/findBuscar mensagens em um chatchats:read
• POST/instances/{id}/whatsapp/message/markreadMarcar mensagens como lidaschats:write
• POST/instances/{id}/whatsapp/message/reactEnviar reação a uma mensagemwhatsapp:write
• POST/instances/{id}/whatsapp/message/deleteApagar Mensagem Para Todoswhatsapp:write
• POST/instances/{id}/whatsapp/message/editEdita uma mensagem enviadawhatsapp:write
• POST/instances/{id}/whatsapp/call/makeIniciar chamada de vozwhatsapp:write
• POST/instances/{id}/whatsapp/call/rejectRejeitar chamada recebidawhatsapp:write

Conversas e contatos17

• POST/instances/{id}/whatsapp/chat/findBusca chats com filtroschats:read
• POST/instances/{id}/whatsapp/chat/detailsObter Detalhes Completoschats:read
• POST/instances/{id}/whatsapp/chat/checkVerificar Números no WhatsAppwhatsapp:read
• POST/instances/{id}/whatsapp/chat/deleteDeleta chatchats:write
• POST/instances/{id}/whatsapp/chat/archiveArquivar/desarquivar chatchats:write
• POST/instances/{id}/whatsapp/chat/readMarcar chat como lido/não lidochats:write
• POST/instances/{id}/whatsapp/chat/muteSilenciar chatchats:write
• POST/instances/{id}/whatsapp/chat/pinFixar/desafixar chatchats:write
• POST/instances/{id}/whatsapp/chat/labelsGerencia labels de um chatchats:write
• POST/instances/{id}/whatsapp/chat/blockBloqueia ou desbloqueia contato do WhatsAppchats:write
• GET/instances/{id}/whatsapp/chat/blocklistLista contatos bloqueadoschats:read
• POST/instances/{id}/whatsapp/label/editEditar etiquetachats:write
• GET/instances/{id}/whatsapp/labelsBuscar todas as etiquetaschats:read
• GET/instances/{id}/whatsapp/contactsRetorna lista de contatos do WhatsAppchats:read
• POST/instances/{id}/whatsapp/contacts/listListar todos os contatos com paginacaochats:read
• POST/instances/{id}/whatsapp/contact/addAdiciona um contato à agendachats:write
• POST/instances/{id}/whatsapp/contact/removeRemove um contato da agendachats:write

Grupos e canais42

• POST/instances/{id}/whatsapp/group/createCriar um novo grupogroups:write
• POST/instances/{id}/whatsapp/group/infoObter informações detalhadas de um grupowhatsapp:read
• POST/instances/{id}/whatsapp/group/invite-infoObter informações de um grupo pelo código de convitewhatsapp:read
• POST/instances/{id}/whatsapp/group/joinEntrar em um grupo usando código de convitegroups:write
• POST/instances/{id}/whatsapp/group/leaveSair de um grupogroups:write
• GET/instances/{id}/whatsapp/group/listListar todos os gruposwhatsapp:read
• POST/instances/{id}/whatsapp/group/listListar todos os grupos com filtros e paginacaowhatsapp:read
• POST/instances/{id}/whatsapp/group/reset-invite-codeResetar código de convite do grupogroups:write
• POST/instances/{id}/whatsapp/group/update-announceConfigurar permissões de envio de mensagens no grupogroups:write
• POST/instances/{id}/whatsapp/group/update-descriptionAtualizar descrição do grupogroups:write
• POST/instances/{id}/whatsapp/group/update-imageAtualizar imagem do grupogroups:write
• POST/instances/{id}/whatsapp/group/update-lockedConfigurar permissão de edição do grupogroups:write
• POST/instances/{id}/whatsapp/group/update-nameAtualizar nome do grupogroups:write
• POST/instances/{id}/whatsapp/group/update-participantsGerenciar participantes do grupogroups:write
• POST/instances/{id}/whatsapp/community/createCriar uma comunidadegroups:write
• POST/instances/{id}/whatsapp/community/editgroupsGerenciar grupos em uma comunidadegroups:write
• POST/instances/{id}/whatsapp/newsletter/createCriar canalgroups:write
• GET/instances/{id}/whatsapp/newsletter/listListar canais inscritoswhatsapp:read
• POST/instances/{id}/whatsapp/newsletter/infoBuscar informações de um canalwhatsapp:read
• POST/instances/{id}/whatsapp/newsletter/linkBuscar canal por link-chave de convitewhatsapp:read
• POST/instances/{id}/whatsapp/newsletter/subscribeAssinar live updates temporários de um canalwhatsapp:read
• POST/instances/{id}/whatsapp/newsletter/messagesBuscar mensagens de um canalwhatsapp:read
• POST/instances/{id}/whatsapp/newsletter/messages/editEditar mensagem recente de um canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/messages/deleteDeletar mensagem recente de um canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/updatesBuscar updates de mensagens de um canalwhatsapp:read
• POST/instances/{id}/whatsapp/newsletter/viewedMarcar posts do canal como visualizadoschats:write
• POST/instances/{id}/whatsapp/newsletter/reactionReagir a um post do canalwhatsapp:write
• POST/instances/{id}/whatsapp/newsletter/followSeguir canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/unfollowDeixar de seguir canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/muteSilenciar canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/unmuteRemover mute do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/deleteDeletar canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/pictureAtualizar foto do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/nameAtualizar nome do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/descriptionAtualizar descrição do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/settingsAtualizar configurações do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/searchPesquisar canais públicoswhatsapp:read
• POST/instances/{id}/whatsapp/newsletter/admin/inviteConvidar admin do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/admin/acceptAceitar convite de admin do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/admin/removeRemover admin do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/admin/revokeRevogar convite de admin do canalgroups:write
• POST/instances/{id}/whatsapp/newsletter/owner/transferTransferir dono do canalgroups:write

Perfil e configurações18

• POST/instances/{id}/whatsapp/instance/resetReiniciar runtime da instânciasettings:write
• GET/instances/{id}/whatsapp/instance/privacyBuscar configurações de privacidadesettings:read
• POST/instances/{id}/whatsapp/instance/privacyAlterar configurações de privacidadesettings:write
• POST/instances/{id}/whatsapp/instance/presenceAtualizar status de presença da instânciasettings:write
• POST/instances/{id}/whatsapp/instance/update-delay-settingsDelay na fila de mensagenssettings:write
• GET/instances/{id}/whatsapp/instance/proxyObter configuração de proxy da instânciasettings:read
• POST/instances/{id}/whatsapp/instance/proxyConfigurar ou alterar o proxysettings:write
• DELETE/instances/{id}/whatsapp/instance/proxyRemover o proxy configuradosettings:write
• POST/instances/{id}/whatsapp/profile/nameAltera o nome do perfil do WhatsAppsettings:write
• POST/instances/{id}/whatsapp/profile/imageAltera a imagem do perfil do WhatsAppsettings:write
• POST/instances/{id}/whatsapp/business/get/profileObter o perfil comercialwhatsapp:read
• GET/instances/{id}/whatsapp/business/get/categoriesObter as categorias de negócioswhatsapp:read
• POST/instances/{id}/whatsapp/business/update/profileAtualizar o perfil comercialsettings:write
• POST/instances/{id}/whatsapp/business/catalog/listListar os produtos do catálogowhatsapp:read
• POST/instances/{id}/whatsapp/business/catalog/infoObter informações de um produto do catálogowhatsapp:read
• POST/instances/{id}/whatsapp/business/catalog/deleteDeletar um produto do catálogosettings:write
• POST/instances/{id}/whatsapp/business/catalog/showMostrar um produto do catálogosettings:write
• POST/instances/{id}/whatsapp/business/catalog/hideOcultar um produto do catálogosettings:write

Automação15

• POST/instances/{id}/whatsapp/instance/updatechatbotsettingsChatbot Configuraçõessettings:write
• POST/instances/{id}/whatsapp/instance/update-fields-mapAtualizar campos personalizados de leadssettings:write
• POST/instances/{id}/whatsapp/agent/editCriar/Editar Agentesettings:write
• GET/instances/{id}/whatsapp/agent/listTodos os agentessettings:read
• POST/instances/{id}/whatsapp/trigger/editCriar, atualizar ou excluir um trigger do chatbotsettings:write
• GET/instances/{id}/whatsapp/trigger/listListar todos os triggers do chatbotsettings:read
• POST/instances/{id}/whatsapp/knowledge/editCriar/Editar Conhecimento do Agentesettings:write
• GET/instances/{id}/whatsapp/knowledge/listListar Base de Conhecimentosettings:read
• POST/instances/{id}/whatsapp/function/editCriar/Editar função para integração com APIs externassettings:write
• GET/instances/{id}/whatsapp/function/listLista todas as funções de APIsettings:read
• POST/instances/{id}/whatsapp/quickreply/editCriar, atualizar ou excluir resposta rápidasettings:write
• GET/instances/{id}/whatsapp/quickreply/showallListar todas as respostas rápidassettings:read
• GET/instances/{id}/whatsapp/chatwoot/configObter configuração do Chatwootsettings:read
• PUT/instances/{id}/whatsapp/chatwoot/configAtualizar configuração do Chatwootsettings:write
• POST/instances/{id}/whatsapp/chat/edit-leadEdita informações de leadchats:write

Campanhas7

• POST/instances/{id}/whatsapp/sender/simpleCriar nova campanha (Simples)campaigns:write
• POST/instances/{id}/whatsapp/sender/advancedCriar envio em massa avançadocampaigns:write
• POST/instances/{id}/whatsapp/sender/editControlar campanha de envio em massacampaigns:write
• POST/instances/{id}/whatsapp/sender/cleardoneLimpar mensagens enviadascampaigns:write
• DELETE/instances/{id}/whatsapp/sender/clearallLimpar toda fila de mensagenscampaigns:write
• GET/instances/{id}/whatsapp/sender/listfoldersListar campanhas de enviowhatsapp:read
• POST/instances/{id}/whatsapp/sender/listmessagesListar mensagens de uma campanhawhatsapp:read