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.

Fondo

Un webhook es un mensaje automatizado, o una solicitud HTTP, que se envía de una aplicación a otra en tiempo real cuando ocurre un evento específico, lo que permite actualizaciones de datos en tiempo real sin la 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 compañías y proyectos permitir que desarrolladores e integradores de terceros se suscriban a notificaciones de eventos para uno o más recursos de la Procore API cuando se produzcan acciones de creación, actualización o eliminación. Por ejemplo, es posible que una integración de terceros RFI desee recibir una notificación cada vez que se cree una nueva RFI en Procore.

Los beneficios de la característica de los Webhooks incluyen:

• Permite 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 de Procore tan pronto como ocurre un evento. Esto garantiza que los sistemas estén siempre actualizados.

• Permitir la automatización de flujos de trabajo mediante el desencadenamiento de acciones en aplicaciones de terceros cada vez que se producen eventos específicos.

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

• Reducir el número de solicitudes de API a través de sondeos puede suponer un importante ahorro de costes, especialmente para las aplicaciones que manejan grandes volúmenes de datos.

Aspectos a tener en cuenta

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

Creación de un nuevo gancho

1. Navegue hasta la herramienta Administrador a nivel proyecto. 

2. En "Configuración del 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 gancho que incluye una serie de campos y controles para configurar un gancho.

4. Configuración del punto final:

• URL del punto final : ingrese la URL del punto final en el servidor web de terceros que manejará las solicitudes POST provenientes de Procore cuando se active un webhook.
• Encabezado de autorización (opcional): ingrese el token de autorización que desea colocar en el encabezado de la solicitud POST enviada desde Procore. Aunque este campo se puede usar para definir cualquier información de encabezado de autorización que desee, se usa más comúnmente para especificar credenciales de autorización para el servidor de terceros. Por ejemplo, una entrada válida para este campo podría ser 'Basic c3a24b8208ac5199d083d54a1234e94b8864'.
• Formato de carga útil : seleccione la versión de carga útil de la API REST que desea enviar al servicio de terceros. Deberá trabajar con el desarrollador tercero para comprender qué formato de carga útil se prefiere. Tenga en cuenta que una vez que se crea el gancho, la versión de la carga útil no se puede cambiar. Deberá eliminar y volver a crear el gancho 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 que desea 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 gancho, puede ver el estado de los eventos que Procore ha enviado al servicio de terceros.
La sección Descripción general proporciona un resumen de alto nivel del gancho, incluido el estado del gancho y otra información relevante.

La sección Eventos muestra el historial de eventos del gancho 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 el estado del evento son los siguientes:

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

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

• Error: se ha producido un error en la entrega del evento.

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

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

Puede realizar una variedad de acciones con la lista de eventos:

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

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

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

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

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

Ver también

• Para obtener información sobre cómo configurar Webhooks a nivel compañía, consulte Configurar Webhooks compañía.
• Las configuraciones del Webhook del proyecto son compatibles con las plantillas de proyectos. Para obtener información adicional, consulte Configurar una plantilla de proyecto.