O HireHop pode enviar uma mensagem com dados para outros aplicativos quando determinados eventos são acionados no HireHop. Essa mensagem é chamada de webhook que envia automaticamente os dados relevantes para o local necessário.
O que é um webhook?
Um webhook envia/envia uma mensagem, com dados anexados à mensagem, quando coisas específicas acontecem no HireHop (um evento). Os webhooks são enviados via HTTP (chama um endereço da web) e são uma forma de enviar dados para outros aplicativos em tempo real. Os webhooks entregam os dados relevantes para aplicativos específicos à medida que eles acontecem, o que significa que o aplicativo receptor obtém os dados imediatamente após a ocorrência do evento, o que é muito mais eficiente e rápido do que pesquisar alterações de dados.
Os webhooks do HireHop podem ser usados para se comunicar diretamente com outros aplicativos ou ser enviados para um conector como o Zapier, que pode ser feito para formatar os dados e fazer as chamadas de API necessárias de volta ao HireHop ou a outro aplicativo.
Configurando um webhook
No HireHop, vá para “Configurações” e clique na guia “Configurações da empresa” e no botão “Webhooks” na parte superior da página. Na janela pop-up, clique no botão “Novo” e adicione o URL para o qual a mensagem do webhook deve ser enviada e selecione todos os webhook aos quais você deseja que o URL responda. Você pode adicionar quantos webhooks quiser, mas deve limitá-los apenas aos necessários aos quais a URL específica responderá.
Um webhook HireHop enviará dados para seu endpoint de URL como JSON e conterá os dados a seguir ou semelhantes.
{
"time": "2022-03-29 07:50:42",
"user_id": 1,
"user_name": "John Smith",
"user_email": "john@email.com",
"company_id": 1,
"export_key": "22u43mrjwe7u",
"event": "invoice.status.updated",
"data": { ... },
"changes": {
"FIELD_NAME": {
"from": "velho",
"to": "novo"
}, ...
}
}
No exemplo JSON acima, os campos a seguir são:
- “time” é a hora UTC e a data em que o webhook foi enviado.
- “user_id” é o ID do usuário que acionou o evento.
- “user_name” é o nome do usuário.
- “company_id” é o identificador de número exclusivo da empresa para a qual o usuário trabalha.
- “export_key” é o valor da chave de exportação nas configurações da empresa que pode ser usada como verificação de segurança.
- “event” é o nome do evento de webhook que foi acionado.
- “data” são os dados que pertencem ao evento webhook.
- “changes” são os campos que mudaram, sendo o que eram para o que foram alterados.
O HireHop não aguardará uma resposta do URL chamado ou relatará um erro HTTP ao chamá-lo.
O código PHP de exemplo para um endpoint de URL para capturar os dados do webhook seria:
<?php // Obtenha os dados JSON $postdata = file_get_contents('php://input'); // Converter dados JSON em um objeto $data_str = json_decode($postdata); ?>