Skip to content

Conectividad

Webhooks

Desencadenar acciones con webhooks

Un webhook es un endpoint HTTP que recibe eventos desde CMMShere.

Los webhooks te permiten ser notificado acerca de una acción o evento realizado en CMMShere, tales como:

  • Registro de Ordenes de Trabajo (ot.created)
  • Creación de Clientes (cli.created)
  • Modificación de Activos (act.updated)
En CMMShere puedes crear varios webhooks, cada uno de ellos apuntando a una URL diferente y enviando información de las acciones o eventos que tu elijas. 

Construye tu propio webhook

Puedes crear un manejador de webhooks en tu propio servidor para gestionar y recibir varias acciones enviadas desde CMMShere. Comienza exponiendo un endpoint que pueda recibir requests de CMMShere. Cada request enviado desde CMMShere contiene un Evento en formato JSON con la información del objeto que fue modificado (Orden de Trabajo, Solicitud de Trabajo, Cliente, Contacto, Activo, etc.)

Creación de webhook

Realiza la creación de un webhook desde tu cuenta de CMMShere, primero dirígete a Configuración > Conexiones y APIs > Webhooks.

Deberias estar en la vista donde se mostrará el listado de Webhooks que hayamos creado, para crear un nuevo Webhook pulsaremos el botón .

En el formulario de creación de webhooks, debemos especificar una URL publicamente accesible HTTPS hacia la que se enviará el payload con la información del evento, especificar una descripción y seleccionar los eventos que serán enviados hacia la URL mencionada.

 

image_2022-07-27_154622706

Una vez que el webhook haya sido creado, desde ese momento se enviarán payloads en base a los eventos seleccionados y asociados a dicho Webhook.

Recepción de la información

Cada vez que un evento del webhook sea realizado en CMMShere, la información correspondiente será enviada a la URL especificada al momento de la creación del webhook. De esta manera podemos tener la nueva información en tiempo real en nuestro sistema de destino.

Resumen – Pasos para recibir webhooks

Puedes comenzar a recibir eventos en tu aplicación siguiendo los pasos en esta sección:

  1. Identifica los eventos que quieres monitorizar 
  2. Crea un endpoint de webhook como una URL en tu servidor local
  3. Maneja las solicitudes de CMMShere recibiendo cada objeto de evento y retornando respuestas de estado 2xx.
  4. Despliega el endpoint de tu webhook de modo que sea accesible publicamente como una URL HTTPS
  5. Registra tu URL HTTPS publicamente accesible desde tu cuenta de CMMShere 

Creación de Solicitud de Trabajo

El siguiente ejemplo muestra el payload enviado cuando se crea una solicitud de trabajo.

En el JSON que se envia se toma en cuenta la solicitud de trabajo, cliente asociado, usuario_creador y activo.

 

				
					{
  "created": "2022-07-26T16:01:03.000000Z",
  "object": "event",
  "type": "sol.created",
  "data": {
    "object": {
      "id": "sol_1y9pAe09o",
      "object": "solicitud_trabajo",
      "codigo": "RQ000470",
      "titulo": "Solicitud de trabajo de CMMShere",
      "descripcion": "descripcion de prueba con webhook site",
      "created": "2022-07-26T16:01:03.000000Z"
    },
    "client": {
      "id": "cli_Rp19emy92",
      "object": "cliente",
      "codigo": "C0000004",
      "nombre_comercial": "BANCO NACIONAL S.A.",
      "nombre_legal": "BANCO NACIONAL S.A.",
      "caracteristicas": "BANCA Y FINANZAS",
      "nro_id": "1016253021",
      "direccion": "AV. CMMS No. 1296 ESQUINA COLON ZONA CENTRAL",
      "pais": "USA",
      "ciudad": "Miami",
      "email": null,
      "telefono": null
    },
    "user": {
      "id": "cliusu_A1R9mp292",
      "object": "usuario_cliente",
      "nombre": "admin",
      "ap_paterno": " ",
      "ap_materno": " ",
      "email": "admin@cmmshere.com",
      "username": "admin",
      "descripcion": "admin"
    },
    "asset": {
      "id": null,
      "object": "activo"
    }
  }
}
				
			

Subscríbete a nuestro newsletter

Ingresa la dirección de tu email y haz clic en suscríbete.