Configurar webhooks de proyecto

Objetivo

Configure la función Webhooks para recibir notificaciones cuando cambien uno o más recursos de la API de Procore en un proyecto.

Contexto

Un webhook es un mensaje automatizado, o una solicitud HTTP, que se envía de una aplicación a otra en tiempo real cuando se produce un evento específico, lo que permite actualizaciones de datos en tiempo real sin necesidad de sondeos constantes o solicitudes manuales. Los webhooks automatizan el proceso de transferencia de datos entre aplicaciones, eliminando la necesidad de que una aplicación busque constantemente actualizaciones de otra.

En el contexto de Procore, la función webhooks permite a los administradores de la empresa y del proyecto permitir que desarrolladores e integradores externos se suscriban a notificaciones de eventos para uno o más recursos de la API de Procore cuando se producen acciones de creación, actualización o eliminación. Por ejemplo, una integración de RFI de terceros puede querer recibir una notificación cada vez que se cree una nueva RFI en Procore.

Las ventajas de la función de webhooks incluyen:

• Habilitación de la comunicación instantánea entre Procore y aplicaciones y servicios de terceros. En lugar de esperar a que una aplicación solicite información, los webhooks envían datos desde Procore tan pronto como se produce un evento. Esto garantiza que los sistemas estén siempre actualizados.

• Habilitar la automatización de los flujos de trabajo mediante la activación de acciones en aplicaciones de terceros cada vez que se produzcan eventos específicos.

• Al eliminar la necesidad de sondeos constantes, los webhooks reducen la carga en los servidores y ahorran ancho de banda. Esto se traduce en un uso más eficiente de los recursos.

• Reducir el número de solicitudes de API mediante sondeos puede generar un ahorro significativo de costes, especialmente para las aplicaciones que manejan grandes volúmenes de datos.

Temas a considerar

• Información del administrador:
  • "Administrador" en la herramienta Administrador del proyecto.
• Información del desarrollador:
  • Consulte las guías de Introducción a Webhooks y Uso de la API de Webhooks en el Portal para desarrolladores para obtener información sobre cómo desarrollar su aplicación o integración para admitir adecuadamente Webhooks.

Crear un nuevo gancho

1. Vaya a la herramienta Administrador de nivel de proyecto. 

2. En "Configuración de proyecto", haga clic en Webhooks.

3. En la página Webhooks, haga clic en Crear hook.

Esto abre una nueva página de configuración de enlaces que incluye una serie de campos y controles para configurar un enlace.

4. Configuración de punto final:

• URL del extremo. Introduzca la URL del extremo en el servidor web de terceros que manejará las solicitudes POST provenientes de Procore cuando se active un webhook.
• Encabezado de autorización (opcional). Introduzca el token de autorización que desea que se coloque en el encabezado de la solicitud POST enviada desde Procore. Aunque este campo se puede utilizar para definir cualquier información de encabezado de autorización que desee, se suele utilizar para especificar las credenciales de autorización para el servidor de terceros. Por ejemplo, una entrada válida para este campo podría ser "Básico c3a24b8208ac5199d083d54a1234e94b8864".
• Formato de carga : seleccione la versión de carga de la API REST que desea enviar al servicio de terceros. Deberá trabajar con el desarrollador externo para saber qué formato de carga útil prefiere. Tenga en cuenta que una vez creado el enlace, no se puede cambiar la versión de la carga útil. Deberá eliminar y volver a crear el enlace si necesita cambiar la versión de la carga útil. Para obtener información adicional, consulte Formatos de carga útil de webhooks.

5. Seleccione los eventos para enviar:

6. Ver eventos seleccionados:

Puede revisar los eventos de notificación que ha seleccionado y eliminar algunos si es necesario.

Visualización de eventos de webhooks

Una vez que se crea y configura un enlace, puede ver el estado de los eventos que Procore ha enviado al servicio de terceros.
La sección Resumen proporciona un resumen de alto nivel del enlace, incluido el estado del enlace y otra información relevante.

La sección Eventos muestra el historial de eventos del enlace seleccionado. El historial de eventos se mantiene durante un período de 28 días consecutivos.

Cada evento se identifica por su nombre de recurso, ID de recurso, tipo de evento, estado del evento y marca de tiempo en UTC.

Los valores posibles para Estado del evento son los siguientes:

• Entregado: el evento se ha entregado correctamente al servicio de terceros.

• Descartado: el evento se ha descartado. No se realizarán más intentos de entrega.

• Error: la entrega del evento ha fallado.

• En cola: el evento se ha puesto en cola para su entrega al servicio de terceros.

• Reintentando: se está intentando nuevamente la entrega del evento.

Puede realizar diversas acciones con la lista de eventos:

• Busque eventos en un recurso específico por ID de recurso.

• Utilice el menú desplegable Nombre del recurso para mostrar solo los eventos del recurso seleccionado.

• Utilice el menú desplegable Estado del evento para mostrar solo los eventos con el estado de evento seleccionado.

• Utilice el botón Filtrar para crear un filtro personalizado en la lista de eventos.

• Haga clic en un evento individual de la lista para ver los detalles.

Consulte también

• Para obtener información sobre cómo configurar webhooks de nivel de empresa, consulte Configurar webhooks de la empresa.
• Las configuraciones de webhooks del proyecto son compatibles con las plantillas de proyecto. Para obtener información adicional, consulte Configurar una plantilla de proyecto.