Saltar al contenido principal
Procore

Configurar los Webhooks de la compañía

Objetivo

Para configurar la función Webhooks para recibir notificaciones cuando uno o más recursos de la API de Procore cambian a nivel compañía.

Antecedentes

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 ser notificados cuando se produzcan acciones de Crear, Actualizar o Eliminar. La interfaz de usuario para configurar la función de Webhooks está disponible a través de la herramienta de Administrador de la compañía 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

  • Permisos de usuario requeridos:
    • Permisos de nivel "Administrador" en la herramienta de Administrador a nivel Compañía.
  • Información del desarrollador:

Pasos

  1. Navegue hasta la herramienta  Administrador a nivel Compañía. 
  2. En "Configuración de la compañía", 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.


    company_webhooks_config.png

 

  1. Haga lo siguiente:
    1. Punto final de notificación. Ingrese la URL del punto final en su servidor web que manejará las solicitudes POST provenientes de Procore.

    2. Punto final de notificación. Ingrese la URL del punto final en su servidor web que manejará las solicitudes POST provenientes de Procore.

    3. Punto final de notificación. Ingrese la URL del punto final en su servidor web que manejará las solicitudes POST provenientes de Procore.

  2. En la Cuadrícula de recursos, coloque una marca de verificación en las casillas "Crear", "Actualizar" y "Eliminar" de los recursos para los que desea recibir las notificaciones correspondientes. Tenga en cuenta que las opciones de acciones que selecciona se aplican inmediatamente a medida que las selecciona, 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 de la compañía hay disponible un registro en ejecución de Webhooks Deliveries 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 Entregas. Al hacer clic en una entrada de entrega, se exponen detalles sobre la carga útil de la solicitud, los encabezados de respuesta y el cuerpo de 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. Haga clic en Más entregas para mostrar el siguiente conjunto de 25 entregas.

more-deliveries.png

Monitoreo y alarmas 

Le recomendamos encarecidamente que establezca un monitoreo adecuado de sus servidores de puntos finales de notificación para asegurar 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 monitoreo que pueden servir para este propósito, entre ellos DatadogNew Relicy otros. Estos servicios proporcionan funciones sólidas de monitoreo que le permiten visualizar fácilmente la salud 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.

Ver también

  • Para obtener información sobre la configuración de los Webhooks a nivel Proyecto, ver Configurar los Webhooks del proyecto.
  • Para obtener información adicional, consulte los materiales incluidos en su invitación beta.