---
title: "Ativando o Conecta Trinks: Um guia de integração via API e Webhooks"
description: Domine a API e os Webhooks da Trinks para transformar seu sistema em um ecossistema integrado e inteligente
---

[Pular para o conteúdo](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#main-content)

[![trinks-logo 1.svg](https://ajuda.trinks.com/hubfs/trinks-logo%201.svg)](https://ajuda.trinks.com/?hsLang=pt-br)

Abrir navegação principal

Fechar navegação principal

 Dúvidas sobre a Trinks? Aqui você soluciona.

- Não há sugestões porque o campo de pesquisa está em branco.

1. [Central de Ajuda da Trinks](https://ajuda.trinks.com/?hsLang=pt-br)
2. [Conecta Trinks](https://ajuda.trinks.com/conecta-trinks?hsLang=pt-br)

# Ativando o Conecta Trinks: Um guia de integração via API e Webhooks

## Domine a API e os Webhooks da Trinks para transformar seu sistema em um ecossistema integrado e inteligente

- [Introdução](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#introducao)
- [Ative o Conecta Trinks no seu negócio](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#ative-o-conecta-trinks-no-seu-negocio)
- [Área do desenvolvedor: Inove com a Trinks](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#area-do-desenvolvedor-inove-com-a-trinks)
- [Explorando a API Trinks](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#explorando-a-api-trinks)
- [Casos de uso da API: Jornadas práticas](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#casos-de-uso-da-api-jornadas-praticas)
- [Recebendo notificações em tempo real com webhooks](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#recebendo-notificacoes-em-tempo-real-com-webhooks)
- ##### [Dados financeiros do evento de Fechamento de Conta](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#dados-financeiros-do-evento-de-fechamento-de-conta)
- ##### <https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#dados-financeiros-do-evento-de-fechamento-de-conta>[Casos de uso de webhooks: Automação inteligente](https://ajuda.trinks.com/ativando-o-conecta-trinks-um-guia-de-integracao-via-api-e-webhooks#casos-de-uso-de-webhooks-automacao-inteligente)

### Introdução

Boas vindas ao recurso definitivo para empresas e desenvolvedores que desejam expandir as capacidades do sistema Trinks.

Este guia foi projetado para ser seu manual completo na jornada de integração, mostrando como conectar outras ferramentas, automatizar processos e criar soluções personalizadas que revolucionam a gestão do seu negócio.

Ao explorar as APIs e Webhooks da Trinks, você transformará seu sistema de uma ferramenta de gestão em um ecossistema conectado, ágil e pronto para o crescimento.

### **1.0 Ative o Conecta Trinks no seu negócio**

Ativar o Conecta Trinks é um passo estratégico para levar a gestão do seu negócio a um novo patamar. A plataforma transforma o sistema Trinks de uma ferramenta de gestão em um ecossistema aberto e integrado, permitindo a automação de inúmeras tarefas manuais. Ao conectar suas ferramentas preferidas, você libera tempo valioso da sua equipe, permitindo que todos se concentrem no que realmente importa: o crescimento do negócio.

A proposta do Conecta Trinks é simples e poderosa: oferecer acesso aberto aos dados do seu sistema através de APIs e Webhooks. Pense neles como uma **ponte de conexão segura** que permite que outros sistemas (como um CRM, uma ferramenta de BI ou um aplicativo próprio) troquem informações com a Trinks de forma automática. Com essa flexibilidade, você pode criar dashboards personalizados, automatizar campanhas de marketing e muito mais, expandindo a gestão para muito além do sistema Trinks.

#### **Principais benefícios**

- **Liberdade total:** Conecte seu sistema preferido à Trinks, criando um fluxo de trabalho sob medida para suas necessidades.
- **Automação completa:** Receba dados via API ou relatórios automáticos, eliminando a necessidade de extração manual de informações.
- **Integrações prontas:** Aproveite conexões nativas com ferramentas líderes de mercado como F360, Cloudia e Bitrix.
- **Suporte técnico:** Conte com documentação completa, tutoriais e acompanhamento especializado para garantir o sucesso da sua integração.

Para os desenvolvedores e equipes técnicas, esta é a porta de entrada para construir as soluções que farão essa transformação acontecer.

### **2.0 Área do desenvolvedor: Inove com a Trinks**

Olá, dev! A Trinks é a parceira de crescimento de mais de 40 mil negócios de beleza e bem-estar no Brasil, e queremos te convidar para fazer parte dessa revolução. A Área do Desenvolvedor é o seu espaço para criar soluções inovadoras que, conectadas à nossa plataforma robusta e escalável, impactarão positivamente o dia a dia de milhares de empreendedores. Nossa missão é fornecer as ferramentas para que você possa construir integrações incríveis.

#### **Por que integrar com a Trinks?**

- **Alcance um novo mercado:** Exponha sua solução para uma base de clientes engajada e com sede de inovação e crescimento.
- **Tecnologia de ponta:** Construa sobre uma plataforma sólida que processa milhões de agendamentos e transações, garantindo estabilidade e performance.
- **Parceria de verdade:** Faça parte de um ecossistema selecionado e conte com nosso suporte para impulsionar e divulgar sua solução.
- **Inovação contínua:** Esteja na vanguarda do mercado, oferecendo recursos que realmente transformam a rotina dos negócios de beleza.

Abaixo, vamos explorar como funciona. Você também pode explorar tudo na nossa documentação técnica:

**🔗https://trinks.readme.io/**

### **3.0 Explorando a API Trinks**

Nossa API foi construída com base nos princípios REST, utilizando URLs previsíveis, retornando respostas no formato JSON e empregando códigos de status HTTP padrão para sinalizar os resultados das operações. O objetivo é proporcionar uma jornada de desenvolvimento ágil, intuitiva e sem complicações.

#### **3.1 Primeiros passos e autenticação**

Para obter acesso à API e começar a desenvolver, siga os passos abaixo:

1. **Esteja cadastrado na Trinks:** O usuário responsável pela integração deve possuir um perfil vinculado ao estabelecimento.
2. **Realize a solicitação:** Envie um pedido formal através do[Fale Conosco](https://www.trinks.com/FaleConosco?hsLang=pt-br), informando o nome e o e-mail do usuário responsável.
3. **Receba o token:** O token de acesso estará disponível para visualização na sua área de cadastro em[Minha Área/Meu Cadastro](https://www.trinks.com/MinhaArea/MeuCadastro?hsLang=pt-br).

A autenticação é baseada em uma chave de API (ApiKey). Você deve incluir sua chave em todas as requisições, enviando-a através do cabeçalho HTTP X-Api-Key.

X-Api-Key: SUA\_CHAVE\_DE\_API\_AQUI

**Importante:** A chave de API é secreta, pessoal e intransferível. Com ela é possível acessar dados e realizar operações em todos os seus estabelecimentos. Nunca a compartilhe com terceiros.

#### **3.2 Tratamento de erros**

A API utiliza códigos de status HTTP padrão para indicar o sucesso ou a falha de uma requisição.

| Código HTTP | Significado |
| --- | --- |
| **2xx** | Sucesso. A requisição foi recebida, entendida e aceita. |
| **400 Bad Request** | Requisição malformada. Verifique a sintaxe do corpo da sua requisição. |
| **401 Unauthorized** | Falha na autenticação. Sua X-Api-Key está faltando ou é inválida. |
| **403 Forbidden** | Você não tem permissão para acessar o recurso solicitado. |
| **404 Not Found** | O recurso solicitado não foi encontrado no servidor. |
| **429 Too Many Requests** | Você excedeu o limite de requisições permitidas. |
| **5xx** | Erro do nosso lado. Houve um problema interno no servidor. |

#### **3.3 Limites de requisição e boas práticas**

A API possui limites de chamadas para garantir a estabilidade e a performance para todos os usuários:

- **Por minuto:** 60 requisições por chave de API.
- **Por mês:** 5.000 requisições por chave de API (padrão).

Ao exceder o limite por minuto, a API retornará o status HTTP 429 até o minuto seguinte. Ao atingir o limite mensal, todas as requisições serão bloqueadas com o mesmo status até o próximo ciclo.

#### **Como Lidar com os Limites**

- **Controle de taxa:** Implemente um mecanismo no seu sistema para não exceder 60 requisições por minuto.
- **Distribuição de chamadas:** Evite picos de requisições, distribuindo as chamadas ao longo do tempo.
- **Monitoramento:** Monitore o consumo mensal para evitar interrupções no serviço.
- **Uso de cache:** Armazene dados que não mudam com frequência (como lista de serviços ou profissionais) para reduzir o número de chamadas.
- **Otimize chamadas:** Evite chamadas duplicadas ou consultas excessivas (polling).
- **Precisa de mais?** Se precisar de mais requisições, entre em contato com nosso suporte para avaliar seu caso.

#### **3.4 Referência de Endpoints da API**

A seguir, uma visão geral dos principais recursos disponíveis na API.

**Clientes**

- **GET /v1/clientes:** Retorna a lista de clientes, permitindo filtrar por CPF, nome ou data de nascimento. Para incluir as etiquetas vinculadas a cada cliente na resposta, envie o parâmetro `incluirEtiquetas=true`. O padrão é `false`, ou seja, as etiquetas não são retornadas a menos que o parâmetro seja informado.  
  `GET /v1/clientes/{id}`: Obtém os dados de um cliente específico, incluindo o campo `etiquetasAssociadas` com as etiquetas vinculadas a ele.

**Agendamentos**

- **GET /v1/agendamentos:** Lista os agendamentos, permitindo filtrar por data de início, data final e status.

**Produtos**

- **GET /v1/produtos:** Lista todos os produtos, com suporte a paginação através dos parâmetros page e limit.
- **GET /v1/produtos/{produtoId}:** Obtém um produto específico.
- **POST /v1/produtos:** Cria um novo produto.
- **PUT /v1/produtos/{produtoId}:** Atualiza um produto existente.
- **DELETE /v1/produtos/{produtoId}:** Exclui um produto.

**Serviços**

- **GET /v1/servicos:** Lista todos os serviços disponíveis.
- **GET /v1/servicos/{servicoId}:** Obtém um serviço específico.
- **POST /v1/servicos:** Cria um novo serviço.
- **PUT /v1/servicos/{servicoId}:** Atualiza um serviço existente.
- **DELETE /v1/servicos/{servicoId}:** Exclui um serviço.
- **GET /v1/servicos/por-categoria-e-estabelecimento:** Retorna serviços filtrados. Requer os parâmetros estabelecimento\_id e categoria\_id.

**Profissionais**

- **GET /v1/profissionais:** Lista todos os profissionais. A resposta inclui os campos: `idProfissional` (identificador global do profissional), `id` (identificador do vínculo com a unidade), `email`, `status`, `perfilAcesso`, `possuiAgenda`, `fazLancamentoPAT`, `codigoIdentificacao`, `formaRelacaoProfissional`, `funcao`, `dataInicio`, `dataFimContrato` e `dataInativacaoUnidade`.  
  Aceita o parâmetro `status` para filtrar os resultados: `1` (Ativo), `2` (Inativo) ou `3` (Todos). Quando não informado, o padrão é retornar apenas profissionais ativos.
- **GET /v1/profissionais/{profissionalId}:** Obtém um profissional específico.
- **GET /v1/profissionais/{profissionalId}/servicos:** Retorna os serviços de um profissional.
- **POST /v1/profissionais:** Cria um novo profissional.
- **PUT /v1/profissionais/{profissionalId}:** Atualiza um profissional.
- **DELETE /v1/profissionais/{profissionalId}:** Exclui um profissional.

**Estabelecimentos**

- **GET /v1/estabelecimentos:** Lista os estabelecimentos.
- **GET /v1/estabelecimentos/{estabelecimentoId}:** Retorna dados cadastrais de um estabelecimento.
- **PUT /v1/estabelecimentos/{estabelecimentoId}:** Edita dados de um estabelecimento.

**Fidelidade**

- **GET /v1/fidelidade:** Retorna informações do programa de fidelidade.
- **POST /v1/fidelidade:** Adiciona pontos a um cliente.
- **POST /v1/fidelidade/resgatar:** Resgata pontos de um cliente.

**Vendas**

- **GET /v1/vendas:** Retorna as vendas, permitindo filtrar por data de início, data final e forma de pagamento.
- **GET /v1/vendas/{vendaId}:** Obtém uma venda específica.
- **POST /v1/vendas:** Cria uma nova venda.

**Transações**

- **GET /v1/transacoes:** Lista as transações financeiras.
- **GET /v1/transacoes/{transacaoId}:** Obtém uma transação específica.

**Clube e Planos**

- **GET /v1/clube/planos:** Retorna informações sobre planos e assinaturas.
- **GET /v1/clube/planos/{planoId}:** Obtém um plano específico.
- **POST /v1/clube/planos:** Cria um novo plano.
- **PUT /v1/clube/planos/{planoId}:** Edita um plano.
- **DELETE /v1/clube/planos/{planoId}:** Exclui um plano.

Após entender a estrutura da API, o próximo passo é ver como aplicá-la em cenários do mundo real.

### **4.0 Casos de uso da API: Jornadas práticas**

Esta seção abandona a listagem técnica de endpoints em favor de "jornadas práticas". O objetivo é mostrar um passo a passo claro de como utilizar a API para resolver problemas reais de negócio, como realizar um agendamento de ponta a ponta ou sincronizar clientes com um CRM externo.

#### **4.1 Jornada prática: Realizar um agendamento completo**

1. **Passo 1: Listar os serviços que o estabelecimento oferece.** 
     - **Descrição:** Antes de tudo, sua aplicação precisa exibir os serviços disponíveis para o cliente.
     - **Endpoint:** GET /v1/servicos
     - **Para que serve?** Para montar a vitrine de serviços no seu aplicativo, permitindo que o usuário selecione o que deseja agendar. O retorno inclui nome, preço e duração.
2. **Passo 2: Encontrar os profissionais disponíveis.** 
     - **Descrição:** Após a escolha do serviço, liste os profissionais que o realizam.
     - **Endpoint:** GET /v1/profissionais
     - **Para que serve?** Para mostrar a lista de profissionais qualificados e obter o ID daquele que for selecionado.
     - ***Atenção:*** Lembre-se de filtrar na sua aplicação apenas os profissionais com o status ativo: true.
3. **Passo 3: Buscar os horários livres na agenda.** 
     - **Descrição:** Com o serviço e o profissional definidos, é hora de consultar a disponibilidade. A abordagem recomendada é deduzir os horários livres a partir dos ocupados.
     - **Endpoint Principal:** Use GET /v1/agendamentos com os filtros data\_inicial, data\_final e profissionalId para obter todos os horários já preenchidos.
     - **Para que serve?** Ao comparar a lista de horários ocupados com a jornada de trabalho e as regras da agenda (obtidas via GET /v1/estabelecimentos/{id} para horários de funcionamento e GET /v1/agendamentos/configuracoes para regras de negócio), seu sistema pode identificar e exibir para o cliente apenas os horários realmente vagos.
4. **Passo 4: Criar o agendamento (o grande momento!)** 
     - **Descrição:** Com todas as informações validadas, efetive a reserva na agenda.
     - **Endpoint:** POST /v1/agendamentos
     - **Para que serve?** Para reservar o horário e confirmar o agendamento. Envie um JSON com os IDs do cliente, serviço, profissional e a data/hora. Uma resposta 201 Created confirmará o sucesso.
5. **Passo 5: Consultar e, se necessário, cancelar.** 
     - **Descrição:** Permita que o usuário visualize ou cancele seus agendamentos.
     - **Endpoint de Consulta:** GET /v1/agendamentos/{id}
     - **Endpoint de Cancelamento:** DELETE /v1/agendamentos/{id}
     - **Para que serve?** Para exibir o status atualizado do agendamento na sua interface ou processar um cancelamento.

#### **4.2 Jornada prática: Sincronizar clientes com um CRM externo**

1. **Passo 1: Buscar um cliente existente.** 
     - **Descrição:** Antes de criar um novo cadastro, verifique se o cliente já existe na base.
     - **Endpoint:** GET /v1/clientes
     - **Para que serve?** Para encontrar o ID de um cliente usando filtros como nome, CPF ou telefone, evitando a criação de cadastros duplicados.
2. **Passo 2: Criar um novo cliente.** 
     - **Descrição:** Caso o cliente não seja encontrado, crie um novo registro.
     - **Endpoint:** POST /v1/clientes
     - **Para que serve?** Para cadastrar novos usuários na base do estabelecimento. Envie os dados essenciais como nome e telefone para receber o ID do cliente recém-criado.
3. **Passo 3: Atualizar os dados de um cliente.** 
     - **Descrição:** Mantenha as informações dos clientes sempre atualizadas.
     - **Endpoint:** PUT /v1/clientes/{id}
     - **Para que serve?** Para editar informações de um cadastro existente, como telefone ou e-mail.
     - ***Atenção:*** Você precisa passar o ID do cliente na URL e enviar no corpo da requisição apenas os campos que deseja alterar.

#### **4.3 Mais ideias para potencializar sua gestão**

#### **Gestão de agendamentos**

| Para que serve? | Endpoint Sugerido | Ideias para dar um up na sua gestão |
| --- | --- | --- |
| **Buscar e listar agendamentos** | GET /v1/agendamentos | Crie um painel de Business Intelligence (BI) para analisar os horários de pico, os serviços mais agendados e a produtividade dos profissionais. |
| **Criar um novo agendamento** | POST /v1/agendamentos | Permita que seus clientes agendem horários através do seu próprio site, aplicativo da franquia ou totem de autoatendimento, e o horário é criado diretamente na Trinks. |
| **Consultar detalhes de um agendamento** | GET /v1/agendamentos/{id} | Exiba as informações detalhadas de um agendamento em seu sistema de CRM antes de um contato com o cliente. |
| **Ver as regras da sua agenda** | GET /v1/agendamentos/configuracoes | Seu aplicativo personalizado pode consultar essas regras para exibir apenas os horários realmente disponíveis para agendamento online. |
| **Editar um agendamento existente** | PUT /v1/agendamentos/{agendamentoId} | Permita que o cliente altere o horário ou o serviço de um agendamento através do seu aplicativo, e a mudança é refletida na Trinks. |
| **Mudar o status de um agendamento** | PATCH /v1/agendamentos/.../status/{status} | Integre com um sistema de chamada por voz ou painel na recepção. Quando o profissional marca o status como "Em atendimento", o sistema pode chamar o próximo cliente da fila. |
| **Ver a agenda dos profissionais em uma data** | GET /v1/agendamentos/profissionais/{data} | Crie uma visão de disponibilidade para a recepção da sua rede, facilitando encontrar horários livres entre diferentes profissionais ou unidades. |

#### **Conexão com clientes**

| Para que serve? | Endpoint Sugerido | Ideias para dar um up na sua gestão |
| --- | --- | --- |
| **Buscar e listar todos os seus clientes** | GET /v1/clientes | Importe sua base de clientes da Trinks para sua ferramenta de e-mail marketing ou CRM para criar campanhas segmentadas. |
| **Cadastrar um novo cliente** | POST /v1/clientes | Quando um cliente preenche um formulário no seu site ou app, crie o cadastro dele automaticamente na Trinks. |
| **Consultar os dados de um cliente** | GET /v1/clientes/{id} | Tenha a ficha completa do cliente à mão no seu sistema de CRM ou de atendimento ao realizar uma ligação ou contato. |
| **Editar os dados de um cliente** | PUT /v1/clientes/{clienteId} | Permita que o cliente atualize seus próprios dados (como endereço ou e-mail) em uma "área do cliente" no seu site, e a informação é sincronizada na Trinks. |
| **Excluir o cadastro de um cliente** | DELETE /v1/clientes/{clienteId} | Atenda a solicitações de privacidade (LGPD) de forma integrada, removendo o cliente de todos os seus sistemas de uma só vez. |
| **Adicionar créditos para um cliente** | POST /v1/clientes/{clienteId}/creditos | Crie uma campanha de "cashback" no seu sistema de fidelidade. Quando o cliente atinge uma meta, o crédito é inserido automaticamente na conta dele na Trinks. |
| **Gerenciar etiquetas (tags) dos clientes** | GET / POST / DELETE /v1/clientes/{id}/etiquetas | Segmente seus clientes de forma automática. Se um cliente compra um pacote de noiva no seu e-commerce, adicione a etiqueta "Noiva" a ele na Trinks para um atendimento personalizado. |
| **Gerenciar os telefones de um cliente** | GET / POST / DELETE /v1/clientes/{id}/telefones | Mantenha os contatos dos clientes sempre atualizados e sincronizados com sua plataforma de envio de WhatsApp ou SMS. |
| **Lançar um vale-presente para um cliente** | POST /v1/clientes/{clienteId}/valespresentes | Venda vales-presente através do seu site ou aplicativo e, após a confirmação do pagamento, o vale é gerado e associado ao cliente automaticamente na Trinks. |

#### **Inteligência do negócio**

| Para que serve? | Endpoint Sugerido | Ideias para dar um up na sua gestão 🚀 |
| --- | --- | --- |
| **Consultar planos e assinaturas (Clube)** | GET /v1/clube/... | Crie uma área exclusiva para assinantes no seu site ou app, onde eles podem ver os detalhes do plano, o histórico de uso e as estatísticas de consumo. |
| **Buscar dados dos seus estabelecimentos** | GET /v1/estabelecimentos | Alimente um mapa interativo no site da sua franquia com os endereços e contatos de todas as unidades, buscando os dados direto da Trinks. |
| **Listar formas de pagamento** | GET /v1/formaspagamentos | Utilize essa lista para padronizar a conciliação de pagamentos no seu sistema financeiro. |
| **Listar motivos de descontos** | GET /v1/motivosdescontos | Analise em seu sistema de BI quais são os descontos mais utilizados e o impacto deles no faturamento. |
| **Listar transações e vendas** | GET /v1/transacoes e GET /v1/vendas | Exporte os dados de vendas para seu software de contabilidade ou para criar relatórios financeiros personalizados. |
| **Consultar seus produtos, serviços e profissionais** | GET /v1/produtos, GET /v1/servicos, GET /v1/profissionais | Exiba sua vitrine de serviços e produtos em seu próprio site ou app, com informações sempre atualizadas direto da Trinks. |

Enquanto a API é excelente para buscar e enviar dados ativamente, os Webhooks são a solução ideal para receber atualizações do Trinks em tempo real, de forma passiva.

### **5.0 Recebendo notificações em tempo real com webhooks**

Imagine receber um aviso automático sempre que algo importante acontece no seu sistema Trinks, sem precisar fazer consultas repetidas. É exatamente isso que os Webhooks fazem. Eles funcionam como "mensageiros" que notificam seus outros sistemas instantaneamente, via requisições HTTPS, sempre que um evento específico ocorre, como o fechamento de uma conta ou a criação de um novo agendamento.

#### **5.1 Como funcionam os Webhooks Trinks**

O sistema de Webhooks da Trinks utiliza o **Amazon SNS (Simple Notification Service)** para enviar as notificações. Isso significa que seu sistema precisa ter um endpoint (URL) público capaz de receber e processar as mensagens do protocolo SNS. Todas as notificações de eventos para sua franquia ou estabelecimento são centralizadas e enviadas para essa única URL cadastrada.

#### **5.2 Estrutura da mensagem e segurança**

Para garantir a autenticidade e a segurança das notificações, cada mensagem enviada pelo Trinks é assinada digitalmente. É fundamental que o seu sistema receptor valide essa assinatura utilizando o certificado disponível na URL fornecida no campo SigningCertURL do payload.

A estrutura genérica de uma mensagem de webhook é a seguinte:

{

  "Message": "{...}",

  "MessageId": "string",

  "Timestamp": "string",

  "Type": "string",

  "Signature": "string",

  "SigningCertURL": "string",

  "Subject": "string"

}

#### **5.3 Eventos suportados por webhooks**

A plataforma notifica uma ampla gama de eventos de negócio. Cada evento é acompanhado por um código de ação que especifica a natureza da ocorrência.

| Evento | Descrição do Disparo | Códigos de Ação |
| --- | --- | --- |
| **Fechamento de Conta** | Ocorre sempre que uma conta é fechada no sistema - incluindo vendas realizadas para profissionais e compras do Clube de Assinaturas. | 1 (Inclusão) |
| **Estorno de Conta** | Ocorre sempre que uma conta é estornada no sistema. | 9 (Estorno) |
| **Cadastro de Novo Cliente** | Disparado quando um novo cliente é cadastrado. | 1 (Inclusão) |
| **Atualizar Cadastro do Cliente** | Disparado quando os dados de um cliente são atualizados. | 2 (Alteração) |
| **Cadastro de Novo Profissional** | Disparado quando um novo profissional é cadastrado. | 1 (Inclusão) |
| **Atualizar Cadastro do Profissional** | Disparado quando os dados de um profissional são atualizados. | 2 (Alteração) |
| **Inativar Profissional** | Disparado quando um profissional é inativado no sistema. | 3 (Exclusão) |
| **Cadastro de Estabelecimento** | Acionado quando uma nova unidade é cadastrada. | 1 (Inclusão) |
| **Exclusão de Estabelecimento** | Acionado quando uma unidade é desassociada. | 3 (Exclusão) |
| **Alteração de Estabelecimento** | Acionado quando os dados de uma unidade são alterados. | 2 (Alteração) |
| **Inclusão de Agendamento** | Acionado quando um agendamento é criado. | 1 (Inclusão) |
| **Alteração de Agendamento** | Acionado quando um agendamento é modificado. | 2 (Alteração) |
| **Exclusão de Agendamento** | Acionado quando um agendamento é cancelado. | 3 (Exclusão) |

Agora que conhecemos os eventos, vamos ver como eles podem ser usados para automatizar a gestão de forma inteligente.

##### **Dados financeiros do evento de Fechamento de Conta**

O evento de fechamento de conta (TipoDeEvento = 1) também disponibiliza informações financeiras detalhadas da transação, permitindo maior consistência entre integrações externas e os valores exibidos no Relatório Financeiro da Trinks.

📌 Os campos abaixo são complementares e não substituem os já existentes no payload.

###### **Subtotais por tipo de item**

O payload pode retornar os seguintes campos:

- TotalServicos
- TotalProdutos
- TotalPacotes
- TotalValePresente
- TotalCreditoCliente
- TotalClubeAssinaturas
- TotalDescontos
- TotalAPagar

###### **Totais por forma de pagamento**

Também podem ser retornados os valores recebidos por forma de pagamento:

- TotalCredito
- TotalDebito
- TotalDinheiro
- TotalPrePago
- TotalOutros

###### **Campos complementares**

O payload também pode conter:

- Troco
- Gorjeta
- TotalRecebido
- FoiVendaParaProfissional
- ClienteIdentificado

📌 O campo TotalRecebido utiliza a mesma lógica aplicada no Relatório Financeiro da Trinks.

###### **Cenários contemplados pelo evento**

O webhook de fechamento de conta contempla diferentes tipos de transação, incluindo:

- vendas convencionais;
- vendas para profissional;
- compras do Clube de Assinatura.

Nos casos de venda para profissional:

- o campo FoiVendaParaProfissional será enviado como true;
- os dados de cliente poderão ser enviados vazios.

Para itens do Clube de Assinatura:

- o payload poderá retornar TipoItem: 5.

###### **Compatibilidade**

Os campos financeiros adicionais são enviados de forma complementar ao payload atual.

📌 Nenhum campo existente foi removido ou renomeado.

### **6.0 Casos de uso de webhooks: Automação inteligente**

Com os Webhooks, você pode criar automações que reagem instantaneamente a eventos no Trinks. Imagine, por exemplo, um dashboard para a gestão da sua franquia que mostra, em tempo real, o que acontece em cada unidade: vendas fechadas, novos clientes cadastrados e agendamentos confirmados, tudo atualizado automaticamente.

A tabela a seguir transforma os eventos técnicos em soluções de negócio claras e valiosas.

| Quando este evento acontece... | ...seu sistema recebe um aviso automático. | Ideias para dar um up na sua gestão 🙌 |
| --- | --- | --- |
| **Conta é fechada** | Evento: Fechamento de Conta | Envie os dados da venda na mesma hora para seu sistema financeiro (ERP) ou para uma planilha que calcula a comissão dos profissionais automaticamente. |
| **Venda é estornada** | Evento: Estorno de Conta | Atualize seu controle financeiro e de estoque em tempo real, sem precisar de lançamento manual. |
| **Novo cliente é cadastrado** | Evento: Cadastro de Novo Cliente | Inicie uma régua de comunicação automática: envie um e-mail de boas-vindas para o novo cliente através da sua ferramenta de marketing. |
| **Cadastro do cliente é atualizado** | Evento: Atualizar Cadastro do Cliente | Mantenha a base de dados do seu sistema de CRM ou de e-mail marketing sempre sincronizada e atualizada. |
| **Novo profissional é adicionado** | Evento: Cadastro de Novo Profissional | Dispare um processo de onboarding interno, como a criação de acesso do profissional em outras ferramentas da sua rede. |
| **Cadastro do profissional é atualizado** | Evento: Atualizar Cadastro do Profissional | Garanta que as informações do profissional (como telefone ou e-mail) estejam sempre consistentes em todos os sistemas da sua empresa. |
| **Profissional é inativado** | Evento: Inativar Profissional | Revogue acessos do profissional em outros sistemas ou atualize a lista de equipe no site da sua franquia automaticamente. |
| **Novo estabelecimento (unidade) é criado** | Evento: Cadastro de Estabelecimento | Automatize a configuração da nova unidade em outros sistemas da franqueadora, como o financeiro ou de BI. |
| **Estabelecimento (unidade) é excluído** | Evento: Exclusão de Estabelecimento | Sincronize a remoção da unidade em todos os seus sistemas de gestão da rede. |
| **Dados do estabelecimento são alterados** | Evento: Alteração de Estabelecimento | Mantenha informações como endereço, telefone ou responsável sempre atualizadas no sistema da sua franquia. |
| **Novo agendamento é criado** | Evento: Inclusão de Agendamento | Se o agendamento foi feito em um totem ou app próprio, essa notificação confirma que ele foi criado com sucesso na Trinks. |
| **Agendamento é alterado** | Evento: Alteração de Agendamento | Envie uma notificação para o cliente através de um canal alternativo (como WhatsApp ou aplicativo da franquia) informando sobre a mudança. |
| **Agendamento é excluído/cancelado** | Evento: Exclusão de Agendamento | Libere o horário na agenda de outros sistemas integrados ou atualize painéis de disponibilidade em tempo real. |

A combinação da API para consultas ativas e dos Webhooks para notificações passivas oferece um conjunto de ferramentas extremamente poderoso. Com elas, você pode personalizar, automatizar e otimizar a gestão do seu negócio de maneiras que antes eram impossíveis. Explore essas possibilidades, conecte suas ferramentas e acelere o seu crescimento com o Conecta Trinks.

- [Tour pelo Sistema Trinks](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#main-content)

    - [Menu \> Home](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-home)
    - [Menu \> Agenda](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-agenda)
    - [Menu \> Meu Estabelecimento](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-meu-estabelecimento)
    - [Menu \> Relatórios](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-relat%C3%B3rios)
    - [Menu \> Marketing](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-marketing)
    - [Menu \> Configurações](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-configura%C3%A7%C3%B5es)
    - [Menu \> Financeiro](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-financeiro)
    - [Menu \> Minha Trinks](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-minha-trinks)
    - [Menu \> Belezinha Trinks](https://ajuda.trinks.com/tour-pelo-sistema-trinks?hsLang=pt-br#menu-belezinha-trinks)
- [Inicie por aqui](https://ajuda.trinks.com/inicie-por-aqui?hsLang=pt-br#main-content)

    - [Trilhas](https://ajuda.trinks.com/inicie-por-aqui?hsLang=pt-br#trilhas)
    - [Configurações básicas](https://ajuda.trinks.com/inicie-por-aqui?hsLang=pt-br#configura%C3%A7%C3%B5es-b%C3%A1sicas)
    - [Agendamento e Fechamento de conta](https://ajuda.trinks.com/inicie-por-aqui?hsLang=pt-br#agendamento-e-fechamento-de-conta)
    - [Controle Financeiro](https://ajuda.trinks.com/inicie-por-aqui?hsLang=pt-br#controle-financeiro)
    - [Comissão](https://ajuda.trinks.com/inicie-por-aqui?hsLang=pt-br#comiss%C3%A3o)
    - [Marketing e Divulgação](https://ajuda.trinks.com/inicie-por-aqui?hsLang=pt-br#marketing-e-divulga%C3%A7%C3%A3o)
- [Conheça a agenda Trinks](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#main-content)

    - [Agenda](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#agenda)
    - [Agendamento](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#agendamento)
    - [Etiquetas](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#etiquetas)
    - [Fechamento de Conta](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#fechamento-de-conta)
    - [Comandas](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#comandas)
    - [Profissional](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#profissional)
    - [Rodízio de Profissionais](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#rod%C3%ADzio-de-profissionais)
    - [Artigos Relacionados](https://ajuda.trinks.com/conhe%C3%A7a-a-agenda-trinks?hsLang=pt-br#artigos-relacionados)
- [Gestão para Barbearias](https://ajuda.trinks.com/gest%C3%A3o-para-barbearias?hsLang=pt-br)
- [Treinamento Trinks](https://ajuda.trinks.com/treinamento-trinks?hsLang=pt-br)
- [Trinks de Vantagens](https://ajuda.trinks.com/trinks-de-vantagens?hsLang=pt-br)
- [Aplicativo Trinks Profissional](https://ajuda.trinks.com/aplicativo-trinks-profissional?hsLang=pt-br#main-content)

    - [Liberações e personalizações](https://ajuda.trinks.com/aplicativo-trinks-profissional?hsLang=pt-br#libera%C3%A7%C3%B5es-e-personaliza%C3%A7%C3%B5es)
    - [Configurações e lançamentos que podem ser realizados pelo aplicativo](https://ajuda.trinks.com/aplicativo-trinks-profissional?hsLang=pt-br#configura%C3%A7%C3%B5es-e-lan%C3%A7amentos-que-podem-ser-realizados-pelo-aplicativo)
    - [Acesso do aplicativo para perfil administrador](https://ajuda.trinks.com/aplicativo-trinks-profissional?hsLang=pt-br#acesso-do-aplicativo-para-perfil-administrador)
    - [Acesso do aplicativo para perfil profissional](https://ajuda.trinks.com/aplicativo-trinks-profissional?hsLang=pt-br#acesso-do-aplicativo-para-perfil-profissional)
- [FAQ Perguntas Frequentes](https://ajuda.trinks.com/faq-perguntas-frequentes?hsLang=pt-br#main-content)

    - [Começando pelo básico](https://ajuda.trinks.com/faq-perguntas-frequentes?hsLang=pt-br#come%C3%A7ando-pelo-b%C3%A1sico)
    - [Divulgando seu negócio: Aplicativo e Site](https://ajuda.trinks.com/faq-perguntas-frequentes?hsLang=pt-br#divulgando-seu-neg%C3%B3cio-aplicativo-e-site)
    - [Mais facilidades para o seu negócio](https://ajuda.trinks.com/faq-perguntas-frequentes?hsLang=pt-br#mais-facilidades-para-o-seu-neg%C3%B3cio)
    - [Dúvidas sobre Meu Plano e Pagamento](https://ajuda.trinks.com/faq-perguntas-frequentes?hsLang=pt-br#d%C3%BAvidas-sobre-meu-plano-e-pagamento)
- [Novidades](https://ajuda.trinks.com/novidades?hsLang=pt-br)
- [Dicas Trinks](https://ajuda.trinks.com/dicas-trinks?hsLang=pt-br)
- [Profissionais](https://ajuda.trinks.com/profissionais?hsLang=pt-br#main-content)

    - [Artigos Relacionados](https://ajuda.trinks.com/profissionais?hsLang=pt-br#artigos-relacionados)
    - [Profissional Parceiro](https://ajuda.trinks.com/profissionais?hsLang=pt-br#profissional-parceiro)
    - [Pagamento Profissional](https://ajuda.trinks.com/profissionais?hsLang=pt-br#pagamento-profissional)
    - [Cadastrar profissionais](https://ajuda.trinks.com/profissionais?hsLang=pt-br#cadastrar-profissionais)
- [Serviços](https://ajuda.trinks.com/servi%C3%A7os?hsLang=pt-br)
- [Cliente](https://ajuda.trinks.com/cliente?hsLang=pt-br#main-content)

    - [Cadastro de Cliente](https://ajuda.trinks.com/cliente?hsLang=pt-br#cadastro-de-cliente)
    - [Débito de Cliente](https://ajuda.trinks.com/cliente?hsLang=pt-br#d%C3%A9bito-de-cliente)
    - [Anamnese](https://ajuda.trinks.com/cliente?hsLang=pt-br#anamnese)
    - [Crédito de Cliente](https://ajuda.trinks.com/cliente?hsLang=pt-br#cr%C3%A9dito-de-cliente)
- [Produto](https://ajuda.trinks.com/produto?hsLang=pt-br#main-content)

    - [Cadastro de Produto](https://ajuda.trinks.com/produto?hsLang=pt-br#cadastro-de-produto)
    - [Artigos Relacionados](https://ajuda.trinks.com/produto?hsLang=pt-br#artigos-relacionados)
    - [Pedidos de compra](https://ajuda.trinks.com/produto?hsLang=pt-br#pedidos-de-compra)
    - [Pré-venda de produto](https://ajuda.trinks.com/produto?hsLang=pt-br#pr%C3%A9-venda-de-produto)
    - [Venda de produto](https://ajuda.trinks.com/produto?hsLang=pt-br#venda-de-produto)
- [Pacotes](https://ajuda.trinks.com/pacotes?hsLang=pt-br#main-content)

    - [Pacotes](https://ajuda.trinks.com/pacotes?hsLang=pt-br#pacotes)
    - [Venda online de pacotes](https://ajuda.trinks.com/pacotes?hsLang=pt-br#venda-online-de-pacotes)
    - [Nota Fiscal de Pacotes](https://ajuda.trinks.com/pacotes?hsLang=pt-br#nota-fiscal-de-pacotes)
- [Financeiro e Vendas](https://ajuda.trinks.com/financeiro-e-vendas?hsLang=pt-br#main-content)

    - [Pagamento antecipado via site](https://ajuda.trinks.com/financeiro-e-vendas?hsLang=pt-br#pagamento-antecipado-via-site)
    - [Promoção Online](https://ajuda.trinks.com/financeiro-e-vendas?hsLang=pt-br#promo%C3%A7%C3%A3o-online)
- [Estoque](https://ajuda.trinks.com/estoque?hsLang=pt-br#main-content)

    - [Estoque](https://ajuda.trinks.com/estoque?hsLang=pt-br#estoque)
    - [Inventário](https://ajuda.trinks.com/estoque?hsLang=pt-br#invent%C3%A1rio)
    - [Artigos Relacionados](https://ajuda.trinks.com/estoque?hsLang=pt-br#artigos-relacionados)
- [Nota Fiscal](https://ajuda.trinks.com/nota-fiscal?hsLang=pt-br#main-content)

    - [Artigos Relacionados NFS-e](https://ajuda.trinks.com/nota-fiscal?hsLang=pt-br#artigos-relacionados-nfs-e)
    - [NFC-e](https://ajuda.trinks.com/nota-fiscal?hsLang=pt-br#nfc-e)
    - [Artigos Relacionados NFC-e](https://ajuda.trinks.com/nota-fiscal?hsLang=pt-br#artigos-relacionados-nfc-e)
    - [NFS-e](https://ajuda.trinks.com/nota-fiscal?hsLang=pt-br#nfs-e)
- [Despesas](https://ajuda.trinks.com/despesas?hsLang=pt-br#main-content)

    - [Artigos Relacionados](https://ajuda.trinks.com/despesas?hsLang=pt-br#artigos-relacionados)
- [Marketing](https://ajuda.trinks.com/marketing?hsLang=pt-br#main-content)

    - [Whatsapp](https://ajuda.trinks.com/marketing?hsLang=pt-br#whatsapp)
    - [Lembrete Premium](https://ajuda.trinks.com/marketing?hsLang=pt-br#lembrete-premium)
    - [Programa de Fidelidade](https://ajuda.trinks.com/marketing?hsLang=pt-br#programa-de-fidelidade)
    - [SMS Marketing](https://ajuda.trinks.com/marketing?hsLang=pt-br#sms-marketing)
    - [E-mail Marketing](https://ajuda.trinks.com/marketing?hsLang=pt-br#e-mail-marketing)
    - [Vale-Presente](https://ajuda.trinks.com/marketing?hsLang=pt-br#vale-presente)
    - [Cupom de desconto](https://ajuda.trinks.com/marketing?hsLang=pt-br#cupom-de-desconto)
    - [Redes sociais](https://ajuda.trinks.com/marketing?hsLang=pt-br#redes-sociais)
    - [Artigos Relacionados](https://ajuda.trinks.com/marketing?hsLang=pt-br#artigos-relacionados)
- [Belezinha Trinks](https://ajuda.trinks.com/belezinha-trinks?hsLang=pt-br#main-content)

    - [Artigos Relacionados](https://ajuda.trinks.com/belezinha-trinks?hsLang=pt-br#artigos-relacionados)
- [Franquias e Redes](https://ajuda.trinks.com/franquias-e-redes?hsLang=pt-br)
- [Relatórios](https://ajuda.trinks.com/relat%C3%B3rios?hsLang=pt-br#main-content)

    - [Artigos Relacionados](https://ajuda.trinks.com/relat%C3%B3rios?hsLang=pt-br#artigos-relacionados)
- [Agendamento Online](https://ajuda.trinks.com/agendamento-online?hsLang=pt-br)
- [FAQ Integração Stone](https://ajuda.trinks.com/faq-integra%C3%A7%C3%A3o-stone?hsLang=pt-br#main-content)

    - [Utilização da máquina integrada ao sistema](https://ajuda.trinks.com/faq-integra%C3%A7%C3%A3o-stone?hsLang=pt-br#utiliza%C3%A7%C3%A3o-da-m%C3%A1quina-integrada-ao-sistema)
    - [Split de pagamento](https://ajuda.trinks.com/faq-integra%C3%A7%C3%A3o-stone?hsLang=pt-br#split-de-pagamento)
    - [APP Stone](https://ajuda.trinks.com/faq-integra%C3%A7%C3%A3o-stone?hsLang=pt-br#app-stone)
- [Trinks para o seu cliente](https://ajuda.trinks.com/trinks-para-o-seu-cliente?hsLang=pt-br#main-content)

    - [Site](https://ajuda.trinks.com/trinks-para-o-seu-cliente?hsLang=pt-br#site)
    - [Aplicativo](https://ajuda.trinks.com/trinks-para-o-seu-cliente?hsLang=pt-br#aplicativo)
- [Clube de Assinaturas](https://ajuda.trinks.com/clube-de-assinaturas?hsLang=pt-br#main-content)

    - [Nota Fiscal para Clube de Assinaturas](https://ajuda.trinks.com/clube-de-assinaturas?hsLang=pt-br#nota-fiscal-para-clube-de-assinaturas)
- [Geral](https://ajuda.trinks.com/geral?hsLang=pt-br)
- [Conta Digital](https://ajuda.trinks.com/conta-digital?hsLang=pt-br)
- [Trinks BI](https://ajuda.trinks.com/trinks-bi?hsLang=pt-br)
- [Lançamentos e Novidades](https://ajuda.trinks.com/lan%C3%A7amentos-e-novidades?hsLang=pt-br)
- [Agendamento pelo Google](https://ajuda.trinks.com/agendamento-pelo-google?hsLang=pt-br)
- [Nova Belezinha Stone](https://ajuda.trinks.com/nova-belezinha-stone?hsLang=pt-br#main-content)

    - [PIX Belezinha](https://ajuda.trinks.com/nova-belezinha-stone?hsLang=pt-br#pix-belezinha)
- [Belezinha Trinks (Com Split)](https://ajuda.trinks.com/belezinha-trinks-com-split?hsLang=pt-br)
- [Autoatendimento](https://ajuda.trinks.com/autoatendimento?hsLang=pt-br)
- [Conecta Trinks](https://ajuda.trinks.com/conecta-trinks?hsLang=pt-br)
- [Indica Trinks](https://ajuda.trinks.com/indica-trinks?hsLang=pt-br)
- [Sobre a Trinks](https://ajuda.trinks.com/sobre-a-trinks?hsLang=pt-br)
- [Trinks IA](https://ajuda.trinks.com/trinks-ia?hsLang=pt-br)

[![Chill listening crop-3](https://ajuda.trinks.com/hs-fs/hubfs/trinks-logo%201.png?width=124&height=45&name=trinks-logo%201.png "Chill listening crop-3")](https://trinks.com?hsLang=pt-br)

[Quero cadastrar meu negócio](https://www.trinks.com/programa-para-salao-de-beleza?hsLang=pt-br) | [Team Viewer](https://download.teamviewer.com/download/version_13x/TeamViewerQS.exe) | [Anydesk](https://download.anydesk.com/AnyDesk.exe?_ga=2.106069251.1633218056.1605217034-792329752.1599757422) | [Blog](http://blog.trinks.com/)| [Materiais Educativos](https://www.trinks.com/portal/materiais-educativos?hsLang=pt-br)

<https://www.instagram.com/trinksoficial/> <https://www.facebook.com/trinksoficial> <https://www.linkedin.com/company/trinks-com/> <https://www.youtube.com/@TrinksOficial>

Copyright © 2026, Trinks