Saltar al contenido principal
Procore

Configurar webhooks de proyecto

  1. Última actualización
  2. Guardar como PDF

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

La función Webhooks permite a los desarrolladores e integradores de terceros especificar uno o más recursos de la API de Procore para los que desean recibir una notificación cuando se produzcan acciones de creación, actualización o eliminación. La interfaz de usuario para configurar la función Webhooks está disponible a través de la herramienta Administrador del proyecto en Procore.

Las ventajas de la función de webhooks incluyen:

  • Eliminación de la necesidad de lógica/código de sondeo en integraciones de terceros para determinar cambios en los recursos
  • Mejora del rendimiento mediante la sustitución de sondeos por actualizaciones asíncronas
  • Incremento de la eficiencia, ya que el código tiene que ejecutarse cuando un recurso cambia
  • Reducción del riesgo de exceder los límites máximos de la tasa de la API de Procore

Temas a considerar

  • Permiso de usuario necesario:
    • "Administrador" en la herramienta Administrador del proyecto.
  • Información del desarrollador:

Pasos

  1. Vaya a la herramienta Administrador del proyecto.
    Se muestra la página "Información general del proyecto". 
  2. En el menú "Configuración del proyecto" en la barra lateral, haga clic en Webhooks.

    project_settings_webhooks.png

    Esto abre la página de configuración "Webhooks" que incluye un campo de punto final de notificación para introducir la URL de su servidor web y una cuadrícula de recursos para seleccionar los recursos y las acciones de cambio correspondientes para las cuales desea recibir notificación.

    project_webhooks_config.png

 

  1. En el campo Extremo de notificación, introduzca la URL del extremo en su servidor web que manejará las solicitudes POST provenientes de Procore.
  2. (Opcional) En el campo Encabezado de autorización, introduzca el token de autorización que desea colocar en el encabezado de una solicitud POST proveniente de Procore. Aunque este campo se puede usar para definir cualquier información de encabezado de autorización que desee, se usa más habitualmente para especificar credenciales de autorización usando la sintaxis: <type> <credential>, donde <type> es el tipo de autorización ("Basic", "Token", "Bearer", etc.) y <credential> es el valor del token. Por ejemplo, una entrada válida para este campo sería Basic c3a24b8208ac5199d083d54a1234e94b8864.
  3. Haga clic en Guardar extremo. Si introdujo una dirección válida y bien formada en el campo Extremo de notificación, aparecerá un banner verde en la parte superior de la pantalla que indica que la operación finalizó correctamente. Si hay algún problema con la URL que introdujo, aparecerá un banner de advertencia que describe el posible problema.
  4. En la Cuadrícula de recursos, seleccione las acciones "Crear", "Actualizar" y "Eliminar" para cualquier recurso sobre el que desee recibir las notificaciones correspondientes. Tenga en cuenta que sus selecciones de acciones se aplican inmediatamente a medida que las realiza, no es necesario "enviar" los cambios.

    Nota: Cuando configure Webhooks, tenga en cuenta que simplemente está identificando sobre qué recursos o acciones desea recibir notificaciones. Solo cuando se produzca un cambio real en un recurso, recibirá una notificación.

Entregas de webhooks

En la parte inferior de la página Webhooks del proyecto hay disponible un registro de Entregas de Webhooks a su extremo de notificación. La sección Entregas permite ver rápidamente el estado de los eventos que Procore ha enviado (o ha intentado enviar) a su servidor de notificaciones. Tanto las entregas correctas como las fallidas se incluyen en la visualización predeterminada. Puede usar la casilla de verificación "Mostrar solo errores" para filtrar la pantalla y mostrar solo las entregas fallidas.

 

deliveries.png

 

Las entregas más recientes aparecen en la parte superior de la sección "Entregas". Al hacer clic en una entrada de entrega, se exponen detalles sobre la carga de la solicitud, los encabezamientos de respuesta y el cuerpo de la respuesta.

 

deliveries-expand-project.png

La visualización del registro de entregas se pagina con un máximo de 25 entregas mostradas a la vez. Al hacer clic en "Más Entregas", se mostrará el siguiente juego de 25 entregas.

more-deliveries.png

Supervisión y alarmas

Le recomendamos que establezca una supervisión adecuada de sus servidores de extremo de notificación para garantizar que se identifique cualquier tiempo de inactividad u otros problemas relacionados con el rendimiento, y que se le notifique oportunamente a través de un sistema de alarma fiable. Se dispone de muchos sistemas comerciales de supervisión que pueden servir para este propósito, entre ellos Datadog, New Relic y otros. Estos servicios proporcionan funciones sólidas de supervisión que le permiten visualizar fácilmente el estado de su sistema a través de tablas, gráficos y análisis en tiempo real configurables. Estos servicios también proporcionan alertas incorporadas para que se le notifique rápidamente cuando se produzcan problemas.

Consulte también