Saltar al contenido principal
Procore

Configurar los Webhooks del 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

La función Webhooks permite a los programadores 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.

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

  • Eliminación de la necesidad de lógica/código de sondeo en integraciones de terceros para determinar cambios en los recursos
  • Mejorar el rendimiento mediante la sustitución de sondeos por actualizaciones asincrónicas
  • Incrementar la eficiencia ya que el código solo necesita ejecutarse cuando un recurso cambia
  • Reducir el riesgo de exceder los límites máximos de la tasa de la API de Procore

Cosas para considerar

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

Pasos

  1. Navegue hasta la herramienta Administrador del proyecto. 
    Esto revela la página "Información general del proyecto". 
  2. En el menú "Configuración del proyecto" en la barra lateral, haga clic en Webhooks.



    Esto abre la página de configuración "Webhooks" que incluye un campo de punto final de notificación para ingresar 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.

 

  1. En el campo Punto final de notificación, ingrese la URL del punto final en su servidor web que manejará las solicitudes POST provenientes de Procore.
  2. (Opcional) En el campo Encabezado de autorización, ingrese 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 comúnmente para especificar credenciales de autorización usando la sintaxis: <tipo> <credencial>, donde <tipo> es el tipo de autorización ("Básico", "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 punto final. Si ingresó una dirección válida y bien formada en el campo Punto final de notificación, aparecerá un banner verde en la parte superior de la pantalla que indica el que la operación fue exitosa. Si hay algún problema con la URL que ingresó, 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 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 en qué recursos/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 de Webhooks del proyecto hay disponible un registro en ejecución de Entregas de Webhooks a su punto final de notificación. La sección Entregas permite ver rápidamente el estatus de los eventos que Procore ha enviado (o ha intentado enviar) a su servidor de notificaciones. Tanto las entregas exitosas como las fallidas se incluyen en la pantalla por defecto. Puede usar la casilla de verificación Mostrar solo fallas 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 de 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 está paginada con un máximo de 25 entregas mostradas a la vez. Al hacer clic en Más entregas, se mostrará el siguiente conjunto de 25 entregas.

more-deliveries.png

Monitoreo y alarmas

Recomendamos encarecidamente que configure un monitoreo adecuado de sus servidores de punto final de notificación para asegurarse de que se identifique cualquier tiempo de inactividad u otros problemas relacionados con el rendimiento y que se le notifique de manera oportuna a través de un sistema de alarma confiable. Hay muchos sistemas de monitoreo comerciales disponibles que pueden servir para este propósito, incluidos Datadog, New Relic y otros. Estos servicios brindan funciones de monitoreo sólidas que le permiten visualizar fácilmente el estatus de su sistema a través de cuadros, gráficos y análisis en tiempo real configurables. Estos servicios también brindan alertas integradas para que se le notifique de inmediato cuando ocurran problemas.

Ver también

  • Para obtener información sobre cómo configurar Webhooks a nivel compañía, consulte Configurar Webhooks de compañía.
  • Las configuraciones de Webhooks del proyecto son compatibles con las plantillas de proyecto. Para obtener información adicional, consulte Configurar una plantilla de proyecto.
  • Para obtener información adicional, consulte los materiales incluidos en su invitación beta.