O que você precisa
- Uma chave de API de empresa. Chaves de organização são somente leitura e não podem bloquear linhas. Veja Chaves de API.
- O CPF do colaborador desligado e a data do desligamento, vindos do seu sistema de RH.
- Os colaboradores cadastrados na Salvy com CPF e as linhas associadas a eles.
Passo a passo
1
Encontre o colaborador pelo CPF
Filtre a lista de colaboradores pelo CPF. O filtro aceita o CPF com ou sem pontuação.Filtre também por Se
status=active e status=on-hold. O mesmo CPF pode ter mais de um cadastro, por exemplo quando a pessoa foi readmitida. Com esse filtro você ignora os cadastros que já foram desligados. A lista vem ordenada do cadastro mais recente para o mais antigo, então use o primeiro item de data.data vier vazio, não há colaborador ativo com esse CPF e não há nada a bloquear.2
Liste as linhas ativas do colaborador
Filtre as linhas pelo Cada item de
employeeId encontrado e pelo status active.data é uma linha, com id, phoneNumber e name. Se pagination.totalPages for maior que 1, busque as páginas seguintes com o parâmetro page antes de continuar.3
Bloqueie cada linha
Para cada linha, chame o endpoint de bloqueio com o motivo. Use A resposta traz a linha com o estado atual. Bloquear uma linha que já está bloqueada não tem efeito, então repetir esta etapa é seguro.
reason: "other" e descreva o motivo em otherReason, para que o histórico da linha registre por que ela foi bloqueada.4
Marque o colaborador como desligado
Depois que todas as linhas foram bloqueadas, atualize o colaborador com o status Deixe esta etapa por último. A etapa 1 só encontra colaboradores ativos ou afastados: se você marcar o desligamento antes e algum bloqueio falhar, uma nova execução não encontra mais o colaborador e as linhas restantes ficam ativas.
terminated e a data do desligamento.Sem código: workflow do n8n
Se você usa o n8n, baixe o workflow pronto com as quatro etapas. Ele tem dois gatilhos: um manual, para testar, e um webhook, para o seu sistema de RH chamar a cada desligamento.Baixar workflow do n8n
offboarding-block-lines.json: importe no n8n e siga as notas dentro do
workflow.- No n8n, crie um workflow e importe o arquivo (menu ⋯ > Import from File, ou cole o conteúdo do arquivo no editor).
- Crie uma credencial Bearer Auth com a sua chave de API e selecione-a nos quatro nós HTTP.
- Preencha o
cpfno nó Dados de teste e execute. O workflow começa em modo simulação (dryRun = trueno nó Configuração): ele mostra as linhas que seriam bloqueadas, sem bloquear nada. - Quando o resultado estiver certo, troque
dryRunparafalse. Para rodar automaticamente, ative o workflow e faça o seu sistema de RH chamar a URL do nó Webhook do RH com{ "cpf": "...", "terminatedAt": "AAAA-MM-DD" }.
Como implementar
- Gatilho: um webhook do sistema de RH a cada desligamento, uma rotina diária que busca os desligamentos do dia ou um botão no seu sistema interno.
- Modo simulação primeiro. Comece com uma versão que só consulta e mostra as linhas que seriam bloqueadas, sem fazer as chamadas de escrita. Confira o resultado e só depois ative as escritas.
- Ordem das etapas: marque o desligamento só depois de bloquear todas as linhas. Se algum bloqueio falhar, interrompa antes do
PATCH, para que uma nova execução ainda encontre o colaborador.
Cuidados
Teste no sandbox antes de usar em produção
Teste no sandbox antes de usar em produção
Bloquear uma linha em produção interrompe o serviço dela de verdade. Valide o fluxo com uma chave de sandbox (
salvy_test_), com colaboradores e linhas de teste, antes de trocar para a chave de produção. Veja Ambientes.Reexecutar é seguro
Reexecutar é seguro
Se a execução parar no meio, rode de novo com o mesmo CPF. As linhas já bloqueadas não voltam na etapa 2 (elas deixam de ter status
active) e bloquear de novo uma linha bloqueada não tem efeito. Como o desligamento só é marcado no final, o colaborador continua sendo encontrado até todas as linhas estarem bloqueadas.Se você já integra seu RH com a Salvy
Se você já integra seu RH com a Salvy
O
PATCH da etapa 4 conta como uma edição manual, e edições manuais têm prioridade sobre os dados que chegam de integrações. Se o seu sistema de RH já envia o status dos colaboradores para a Salvy, pule a etapa 4 e deixe a integração informar o desligamento. Caso contrário, uma readmissão futura enviada pela integração não substitui o status terminated que você gravou.Linhas sem colaborador associado não são encontradas
Linhas sem colaborador associado não são encontradas
A etapa 2 só encontra as linhas associadas ao colaborador na Salvy. Se a sua empresa costuma deixar linhas sem colaborador, associe cada linha ao colaborador responsável, pelo painel ou por
PATCH /api/v3/phone-accounts/{id}, para que esta receita encontre todas.Variações
- Avisar o gestor. Ao final, envie para o Slack, Teams ou e-mail do gestor um resumo com o nome do colaborador e os números bloqueados.
- Confirmar pelo webhook. Assine o evento
phone-account.blockedpara registrar no seu sistema cada linha bloqueada, inclusive as bloqueadas pelo painel. - Cancelar em vez de bloquear. Se a linha não vai ser reaproveitada por outra pessoa, use Cancelar linha em vez do bloqueio. O bloqueio pode ser desfeito com Desbloquear linha e é a opção mais segura enquanto a linha aguarda um novo responsável.