TalentAxis para desenvolvedores
API e webhooks
Conecte o TalentAxis à sua folha de pagamento, ao RH ou aos seus sistemas internos. Leia e grave candidatos pela API e receba um webhook assinado quando um candidato for criado, mudar de status ou tiver uma entrevista.
Autenticação
As chaves de API são criadas por um Proprietário ou Administrador em Configurações > API e webhooks. O segredo é exibido uma única vez, ao criar a chave. Copie-o nesse momento; se perdê-lo, gere a chave novamente.
Envie o ID da chave e o segredo com autenticação HTTP Basic em cada requisição:
Authorization: Basic base64(key_id:secret)
curl -u "$KEY_ID:$SECRET" https://hireapi.talentaxis.ai/api/v2/public/applicantsURL base: https://hireapi.talentaxis.ai/api/v2
Endpoints
Todos os caminhos partem da URL base indicada acima.
GET /public/applicantsLista candidatos, filtrados por vaga, status ou última atualização, 50 por página.GET /public/applicants/{id}Obtém um candidato com status, tipo de etapa, respostas e origem.POST /public/applicantsCria um candidato.PATCH /public/applicants/{external_id}Atualiza um candidato pelo seu ID externo.POST /public/applicants/move-statusMove candidatos para outro status do processo seletivo.GET /public/account-locationsLista as suas unidades.GET /public/job-hiring-flows/job-idsLista as suas vagas com os respectivos processos seletivos.
Webhooks
Adicione um endpoint https em Configurações > API e webhooks e escolha os eventos que deseja receber. O TalentAxis envia um POST com JSON para cada evento.
Eventos
applicant.createdUm candidato foi criado.applicant.status_changedUm candidato passou para um novo status do processo.interview.scheduledUma entrevista foi agendada.interview.rescheduledUma entrevista foi reagendada.interview.cancelledUma entrevista foi cancelada.
Conteúdo
{
"id": "evt_...",
"type": "applicant.status_changed",
"created_at": "2026-11-19T15:04:05Z",
"company_account_id": "...",
"data": {
"applicant_id": "...",
"job_id": "...",
"hiring_status_id": "...",
"hiring_status_name": "Interview",
"stage_type": "OFFER"
}
}Todos os eventos usam o mesmo envelope. O conteúdo traz apenas IDs e status, nunca nome, telefone, e-mail ou respostas. Para obter os detalhes, chame GET /public/applicants/<applicant_id>.
Verificação de assinaturas
Cada entrega traz um cabeçalho TalentAxis-Signature no formato t=<carimbo de data/hora unix>,v1=<hex>. O valor é um HMAC-SHA256 da string <carimbo>.<corpo bruto>, usando como chave o segredo de assinatura do seu endpoint (exibido uma única vez, ao criar o endpoint). Calcule sobre o corpo bruto da requisição, compare em tempo constante e rejeite a requisição se t tiver mais de 5 minutos.
Node.js
import crypto from "node:crypto";
// rawBody: the request body exactly as received (Buffer or string)
export function verify(header, rawBody, secret) {
const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
const t = Number(parts.t);
if (!t || Math.abs(Date.now() / 1000 - t) > 300) return false; // older than 5 minutes
const expected = crypto.createHmac("sha256", secret).update(`${t}.${rawBody}`).digest("hex");
const given = Buffer.from(parts.v1 ?? "", "hex");
const wanted = Buffer.from(expected, "hex");
return given.length === wanted.length && crypto.timingSafeEqual(given, wanted);
}Python
import hashlib, hmac, time
def verify(header: str, raw_body: bytes, secret: str) -> bool:
parts = dict(p.split("=", 1) for p in header.split(","))
t = int(parts.get("t", 0))
if not t or abs(time.time() - t) > 300: # older than 5 minutes
return False
signed = f"{t}.".encode() + raw_body
expected = hmac.new(secret.encode(), signed, hashlib.sha256).hexdigest()
return hmac.compare_digest(expected, parts.get("v1", ""))Conecte com Zapier ou Make
Você não precisa escrever código. Qualquer ferramenta no-code que receba um webhook e faça uma requisição HTTP pode usar a TalentAxis. Primeiro crie uma chave de API e adicione um webhook em Configurações > API e webhooks, como descrito acima.
Zapier
- Crie um Zap e escolha Webhooks by Zapier > Catch Hook como gatilho. Copie a URL do hook.
- Na TalentAxis, adicione essa URL como webhook, escolha os eventos e clique em Send test para o Zapier receber um exemplo.
- Adicione uma etapa Webhooks by Zapier > GET. Use a URL https://hireapi.talentaxis.ai/api/v2/public/applicants/<applicant_id>, com o applicant_id do gatilho. Configure a autenticação Basic com o ID e o segredo da sua chave.
- Envie o resultado para qualquer app que você use, como folha de pagamento, seu HRIS, Google Sheets ou Slack.
Make
- Crie um cenário e adicione um módulo Custom webhook. Copie a URL dele.
- Na TalentAxis, adicione essa URL como webhook, escolha os eventos e clique em Send test para o Make aprender a estrutura dos dados.
- Adicione um módulo HTTP > Make a request. Use a URL https://hireapi.talentaxis.ai/api/v2/public/applicants/<applicant_id>, método GET, e configure a autenticação Basic com o ID e o segredo da sua chave.
- Conecte o resultado ao próximo módulo, como uma planilha, uma mensagem de chat ou seu sistema de RH.
Os webhooks levam apenas IDs e status, por design. Por isso a segunda etapa busca o candidato com a sua chave. Para mais segurança, você pode verificar o cabeçalho TalentAxis-Signature em uma etapa de código, como mostrado acima em Verificação de assinaturas.
Novas tentativas
Responda com qualquer código 2xx em até 5 segundos. Caso contrário, tentamos novamente após 1 minuto, 5 minutos, 30 minutos, 2 horas e 6 horas. Após 20 eventos consecutivos com falha, o endpoint é desativado automaticamente; corrija-o e ative-o de novo em Configurações > API e webhooks. Use o cabeçalho TalentAxis-Event-Id para ignorar duplicatas.
Versões
A versão da API fica no caminho (/api/v2/). Avisamos sobre mudanças incompatíveis com antecedência e adicionamos campos sem uma nova versão, então ignore os campos que você não conhece.
Referência da API
A referência completa, gerada a partir do esquema em produção.
Carregando a referência da API...