HSDesk APIHSDesk / API Pública

Credenciais no painel

Como gerar a HSDesk Key e cadastrar webhooks pela tela de configuração do HSDesk.

As credenciais e os webhooks são gerenciados no painel do HSDesk por um membro com a permissão api_publica:gerenciar. Tudo também pode ser feito pela API de gestão (JWT); veja a Referência e os endpoints /api/api-keys e /api/webhooks.

Onde fica

No painel: Configurações → API Pública e Webhooks (/dashboard/helpdesk/configuracao). A tela tem duas abas: Credenciais e Webhooks.

Como chegar na tela

No menu lateral do HSDesk, abra Configurações.

Dentro de Configurações, clique em API Pública e Webhooks.

Você cai na tela abaixo, com as abas Credenciais e Webhooks. É aqui que você cria e gerencia suas credenciais de API.

Tela de Configurações → API Pública e Webhooks no painel do HSDesk, com o item destacado na barra lateral e a aba Credenciais aberta

Gerar uma HSDesk Key

Na aba Credenciais, clique em Nova credencial.

Dê um nome que ajude a identificar o uso (ex.: Integração ERP) e clique em Gerar credencial.

A chave (hsk_live_… / hsk_test_…) aparece uma única vez. Copie e guarde em local seguro: ela não será exibida novamente. Se perder, gere outra.

A lista de credenciais mostra nome, prefixo, status, último uso e data de criação. Uma chave ativa pode ser revogada a qualquer momento (passa a responder 401 imediatamente).

Cadastrar um webhook

Na aba Webhooks, clique em Novo webhook.

Informe um nome, a URL de destino (HTTPS, que receberá os POST) e marque os eventos que deseja assinar. Veja a lista completa em Webhooks → Eventos.

Ao salvar, o segredo do webhook (whsec_…) aparece uma única vez. Guarde-o: é com ele que você verifica a assinatura de cada entrega.

Cada webhook pode ser ativado/desativado, editado (inclusive regenerar o segredo) e excluído. Em Ver entregas você acompanha as últimas tentativas de entrega (evento, resultado, status HTTP, tentativa e data) para depurar.

Regenerar o segredo invalida o anterior

Ao regenerar o segredo de um webhook, atualize-o no seu sistema: assinaturas verificadas com o segredo antigo passam a falhar.

On this page