Eventos

Los eventos se disparan por acciones del sistema y se utilizan para informar sobre cambios a usuarios o sistemas externos.

Nuevo usuario

Este evento se dispara cuando un nuevo usuario se une.

{
    event: "user-new",
    payload: {
        id: <uuid>,
        legalId?: <providerId>,
        names: string,
        referenceId: <uuid>,
        roomId: `G:<botId>:<referenceId>`,
        botId: <uuid>,
        companyId: Number,
        socketId: <uuid>,
        createdAt: Date
    }
}

Ejemplo

{
  "event": "user-new",
  "payload": {
    "id": "60b28001-daee-45c1-9b21-3cd8ede9ea1f",
    "names": "Tester #1",
    "referenceId": "60b28001-daee-45c1-9b21-3cd8ede9ea1f",
    "roomId": "G:a6c95322-f419-42b8-a762-5c8eaf20a874:60b28001-daee-45c1-9b21-3cd8ede9ea1f",
    "botId": "a6c95322-f419-42b8-a762-5c8eaf20a874",
    "companyId": 135,
    "socketId": "87d46c82-0987-47a8-8d80-2ef0d08f1a68",
    "createdAt": "2021-12-23T15:20:07.462Z"
  }
}

Mensaje de sala (Room-message)

Este evento ocurre cuando un mensaje es enviado dentro de una sala.

{
        "event": "message:user",
        "origin": "web" | "mobile",
        "app": {
               "id": <botId>,
               ...props: {..}
        },
        "sender": <SenderProps>,
        "room": <RoomProps>,
        "messages": ["https://docs.jelou.ai/webhook/messages-events"],
        "datetime": Date,
 }

Añadir un miembro a la sala (room-member-add)

Este evento se dispara cuando un miembro se agrega a la sala.

{
    "event": "room-member-add",
    "payload": {
        "roomId": <roomId>,
        "member": <uuid>,
        "memberInfo": <MemberProps>,
    },
    "datetime": Date,
}

Eliminar un miembreo de la sala (room-member-remove)

Este evento ocurre cuando un miembro es removido de la sala.

{
    "event": "room-member-remove",
    "payload": {
        "roomId": <roomId>,
        "member": <uuid>,
        "memberInfo": <MemberProps>,
    },
    "datetime": Date,
}

Conversación abierta

Este evento se dispara cuando una conversación se abre.

{
    "event": "conversation-open",
    "payload": {
        "room": <room>,
        "openedBy": <userId>,
    },
    "datetime": Date,
}