Configurar webhooks do projeto

Objetivo

Configurar o recurso Webhooks para receber notificações quando um ou mais recursos da API do Procore forem alterados em um projeto.

Histórico

O recurso Webhooks permite que desenvolvedores e integradores externos especifiquem um ou mais recursos da API do Procore para os quais desejam ser notificados quando houver ações dos tipos Criar, Atualizar ou Excluir. A interface do usuário para configurar o recurso Webhooks é disponibilizada por meio da ferramenta Administrador do projeto no Procore.

Os benefícios do recurso Webhooks incluem:

• Remoção da necessidade de lógica/código de sondagem em integrações de terceiros para determinar alterações de recursos
• Aprimoramento do desempenho ao substituir a sondagem por atualizações assíncronas
• Maior eficiência, pois só é necessário executar o código mediante a alteração de um recurso
• Redução do risco de ultrapassar os limites de taxa da API do Procore

Fatores a considerar

• Permissão de usuário necessária:
  • “Administrador” na ferramenta Administrador dos projetos.
• Informações do desenvolvedor:
  • Consulte os guias Introdução aos webhooks e Como usar a API Webhooks no Portal do desenvolvedor para obter informações sobre como desenvolver seu aplicativo ou integração a fim de oferecer suporte adequado a webhooks.

Etapas

1. Acesse a ferramenta Administrador do projeto. 
   Isso exibirá a página “Informações gerais do projeto”. 
2. No menu “Definições do projeto” na barra lateral, clique em Webhooks.
   
   
   
   Isso abrirá a página de configuração “Webhooks” que inclui um campo Endpoint de notificação para inserir o URL do seu servidor Web e uma Grade de recursos para selecionar os recursos e as ações de alteração correspondentes para as quais você deseja receber notificação.
   
   

3. No campo Endpoint de notificação, insira o URL para o endpoint em seu servidor Web que processará as solicitações POST provenientes do Procore.
4. (Opcional) No campo Cabeçalho de autorização, insira o token de autorização que deseja inserir no cabeçalho de uma solicitação POST proveniente do Procore. Embora seja possível usar esse campo para definir qualquer informação de cabeçalho de autorização que você quiser, ele costuma ser mais usado para especificar credenciais de autorização usando a sintaxe: <type> <credential>, com <type> indicando o tipo de autorização (“Basic”, “Token ”, “Bearer” etc.) e <credential> indicando o valor do token. Por exemplo, uma entrada válida para esse campo seria Basic c3a24b8208ac5199d083d54a1234e94b8864.
5. Clique em Salvar endpoint. Se você tiver inserido um endereço válido e adequadamente formatado no campo Endpoint de notificação, verá um banner verde na parte superior da tela indicando o sucesso da operação. Se houver algum problema com o URL inserido, um banner de aviso será exibido descrevendo o provável problema.
6. Na Grade de recursos, selecione as ações “Criar”, “Atualizar” e “Excluir” para qualquer recurso sobre o qual deseje receber notificações correspondentes. Observe que suas seleções de ação entram em vigor imediatamente conforme você as faz, não havendo necessidade de “enviar” suas alterações.
   
   Obs.:  lembre-se de que, ao configurar webhooks, você estará apenas identificando sobre quais recursos/ações deseja receber notificações. Você só receberá uma notificação quando houver uma alteração real em um recurso.

Entregas de webhooks

Um registro dinâmico das Entregas de webhooks para seu endpoint de notificação está disponível na parte inferior da página Webhooks do projeto. A seção Entregas permite ver rapidamente o status dos eventos que o Procore enviou (ou tentou enviar) ao seu servidor de notificação. Entregas bem-sucedidas e malsucedidas são incluídas na exibição por padrão. Você pode usar a caixa de seleção Mostrar apenas falhas para filtrar a exibição e mostrar apenas as entregas com falha.

As entregas mais recentes aparecem no topo da seção Entregas. Ao clicar em uma entrada de entrega, você verá os detalhes sobre a carga útil da solicitação, cabeçalhos de resposta e corpo da resposta.

A exibição do registro de entregas é paginada com no máximo 25 entregas exibidas por vez. Ao clicar em Mais entregas, você exibirá o próximo conjunto de 25 entregas.

Não deixe de conferir

• Para obter informações sobre como configurar Webhooks no nível de empresa, consulte Configurar webhooks da empresa.
• Há compatibilidade das configurações de webhook com modelos de projeto. Para obter informações adicionais, consulte Configurar um modelo de projeto.