Share via

Esquema de respuesta de webhook para eventos registrados

  • Artículo

Si se registra un webhook, Kaizala devuelve una respuesta de webHook para cada evento en el objectId registrado, filtrado para los eventos registrados. A continuación se muestran los detalles del esquema de diferentes respuestas de webhook para diferentes eventos.

Cuerpo de la respuesta

Parámetro Tipo Descripción
objectId Cadena Identificador que representa el objeto en el que se ha creado el webhook. Para ObjectType=Group, el identificador de su grupo, Para ObjectType=Action, su actionId, For ObjectType=ActionPackage, su action-package-id
objectType Cadena Enumeración: "Group"/"Action"/"ActionPackage"
eventType Cadena Evento registrado que se ha invocado
Eventid Cadena Identificador que representa el evento
data Objeto JSON Objeto que representa datos específicos de ese evento. Parámetros definidos a continuación para cada uno de los eventos admitidos.
contexto Cadena Devuelve el valor que se ha establecido al registrar un webhook en el parámetro "callbackContext".
fromUser Cadena Número de teléfono del remitente
fromUserId Cadena UserId del remitente
fromUserName Cadena Nombre registrado del remitente con Kaizala
fromUserProfilePic url Imagen de perfil del remitente

El parámetro "data" variaría en función del evento webHook. Puede encontrar el esquema para cada evento a continuación.

datos del evento 'TextMessageCreated'

Parámetro Tipo Descripción
text Cadena Mensaje de texto que se ha enviado

Respuesta de webHook de ejemplo para 'TextMessageCreated'

{
  "objectId": "8c2050-9be8-45d6-97f5-bb7013930027",
  "objectType": "Group",
  "eventType": "TextMessageCreated",
  "eventId": "55ed01-02b5-491e-8e7e-484726da976b",
  "data": {
    "text": "Test Message"
  },
  "context": "Any data which is required to be returned in callback",
  "fromUser": "+91xxxxxxxx",
  "fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
  "fromUserName": "Robin Richard",
  "fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}

datos del evento "AttachmentCreated"

Parámetro Tipo Descripción
medios Matriz Cada elemento contiene mediaUrl y mediaFileName
mediaUrl url dirección URL de la imagen
mediaFileName Cadena Filename
actionType Cadena Valor de enumeración : 'Image'
Título Cadena título adjunto a la imagen

Respuesta de webHook de ejemplo para "AttachmentCreated"

{
  "objectId": "8c291050-9be8-45d6-97f5-bb7013930027",
  "objectType": "Group",
  "eventType": "AttachmentCreated",
  "eventId": "59e2e9f9-9b10-4b67-8bc5-3f85a04f2d91",
  "data": {
    "media": [
      {
        "mediaUrl": "https://cdn.inc-000.kms.osi.office.net/att/0ad142c52b30d797addebadb620c19bf6f018299ed4acdce5760e45e2e4bc4ae.jpg?sv=2015-12-11&sr=b&sig=Thbp46wdgoqbDaAF06v2Y2ijzny0jx2fBDo1EZab%2BNY%3D&st=2018-03-22T10:22:21Z&se=2292-01-05T11:22:21Z&sp=r",
        "mediaFileName": "IMG_18-03-22_165220084_1.jpg"
      }
    ],
    "actionType": "Image",
    "caption": "Testing."
  },
 "context": "Any data which is required to be returned in callback",
  "fromUser": "+91xxxxxxxx",
  "fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
  "fromUserName": "Robin Richard",
  "fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}

datos del evento 'Announcement'

Parámetro Tipo Description
title Cadena Título de la acción de anuncio
text Cadena Cuerpo del mensaje de acción de anuncio
medios Matriz Cada elemento contiene mediaUrl y mediaFileName
mediaUrl url dirección URL de la imagen
mediaFileName Cadena Filename

Respuesta de webHook de ejemplo para "Anuncio"

{
  "objectId": "8c291050-9be8-45d6-97f5-bb7013930027",
  "objectType": "Group",
  "eventType": "Announcement",
  "eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
  "data": {
    "text": "Caption :Testing.",
    "title": "Sent by Robin Richard",
    "media": [
      {
        "url": "https://cdn.inc-000.kms.osi.office.net/contenthost/beb2cfef8732c6cc3b54652c1f6f99d64f529fd9be3d409e2966552639fb791f.jpeg",
        "fileName": "e3c145f1-5e6f-4ee9-bd83-49ec3a1c2550.jpeg"
      }
    ]
  },
 "context": "Any data which is required to be returned in callback",
  "fromUser": "+91xxxxxxxx",
  "fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
  "fromUserName": "Robin Richard",
  "fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}

datos del evento 'JobCreated'

Parámetro Tipo Description
title Cadena Título de la acción de anuncio
text Cadena Cuerpo del mensaje de acción de anuncio
actionId Id Identificador de esa instancia concreta de Acción de trabajo
dueDate Fecha Fecha por la que expiraría el trabajo
assignedTo Matriz de cadena Matriz de números de teléfono

Respuesta de webHook de ejemplo para "JobCreated"

{
  "objectId": "8c2950-9be8-45d6-97f5-bb7013930027",
  "objectType": "Group",
  "eventType": "JobCreated",
  "eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
  "data": {
    "assignedTo": [
      "+919740797266"
    ],
    "title": "Test Job",
    "dueDate": "2018-03-22T18:29:59Z",
    "actionId": "aeb012-31a0-477a-a131-8a1e2791b36e",
    "groupId": "8c291050-9be8-6-97f5-bb7013930027"
  },
 "context": "Any data which is required to be returned in callback",
  "fromUser": "+91xxxxxxxx",
  "fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
  "fromUserName": "Robin Richard",
  "fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}

datos del evento 'JobResponse'

Parámetro Tipo Description
title Cadena Título de la acción de anuncio
text Cadena Cuerpo del mensaje de acción de anuncio
actionId Id Identificador de esa instancia concreta de Acción de trabajo
groupId Cadena Identificador de grupo
responseId Cadena GUID para identificar esa respuesta
responseDetails Matriz de cadena Matriz de objetos de respuesta
Cesionario Cadena Número de teléfono del usuario asignado
assigneeName Cadena Nombre del usuario asignado
assigneeProfilePic url dirección URL de la imagen de perfil del asignado
isCompleted Boolean ¿Se ha completado el trabajo?

Respuesta de webHook de ejemplo para "JobResponse"

{
  "objectId": "8c2950-9be8-45d6-97f5-bb7013930027",
  "objectType": "Group",
  "eventType": "JobResponse",
  "eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
  "data": {
    "actionId": "2ce34820-3d67-4807-9a1d-7cf099c2e7ae",
    "groupId": "8c291050-9be8-45d6-97f5-bb7013930027",
    "responseId": "80a883ec-e6c7-4dc8-979d-d268bbeeee8b",
    "responseDetails": {
      "response": {
        "assignee": "++91xxxxxxxx",
        "assigneeName": "Robin Richard",
        "assigneeProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-f391-4e7b-84eb-4e228406fb9b/c34afc0d536285d08e6409e416.jpg",
        "isCompleted": true
      }
    }
  },
  "context": "Any data which is required to be returned in callback",
  "fromUser": "+91xxxxxxxx",
  "fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
  "fromUserName": "Robin Richard",
  "fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}

datos del evento "ActionCreated" / "SurveyCreated"

Parámetro Tipo Descripción
actionId Id Identificador de esa instancia concreta de Acción de trabajo
groupId Cadena Identificador de grupo
responseId Cadena GUID para identificar esa respuesta
Preguntas Matriz de cadena Matriz de objetos
Respondedor Cadena Número de teléfono del respondedor
responderName Cadena Nombre del respondedor
responderProfilePic url url de la imagen de perfil del respondedor
isAnonymous Boolean ¿La respuesta de la encuesta se ha enviado de forma anónima?
isUpdateResponse Boolean El respondedor ha actualizado la respuesta, ya que la respuesta se envió anteriormente.

Detalles del esquema del objeto "responseWithQuestions"

Parámetro Tipo Description
title Cadena Título de la pregunta
type Cadena QuestionType
opciones Matriz Lista de opciones (par clave-valor) aplicables a preguntas de varias opciones
isInvisible Boolean ¿Está oculta la pregunta de la interfaz de usuario?

Respuesta de webHook de ejemplo para "ActionCreated" / "SurveyCreated"

{
  "objectId": "8c2950-9be8-45d6-97f5-bb7013930027",
  "objectType": "Group",
  "eventType": "ActionCreated",
  "eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
  "data": {
   "actionId": "920f9802-62dafb-9bc2-8d3ba5c43609",
    "groupId": "8c291050-9be8-4d6-97f5-bb7013930027",
    "responseId": "420e9ef0-2a6d-405-a2bf-2688648ce79a",
    "isUpdateResponse": false,
    "responder": "+91xxxxxxxxx",
    "responderName": "Robin Richard",
    "responderProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-f391-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg",
    "isAnonymous": false,
    "responseDetails": {
      "responseWithQuestions": [
        {
          "title": "1",
          "type": "Text",
          "options": [],
          "answer": "1"
        },
        {
          "title": "2",
          "type": "AttachmentList",
          "options": [],
          "answer": [
            {
              "mediaUrl": "https://cdn.inc-000.kms.osi.office.net/att/9841be297131449fba1123ec8545ab30fa72c2017555ba4bcd4ac18d5f7850b4.jpg?sv=2015-12-11&sr=b&sig=Egd4wDmAfGrIoklLj70SrV7D3QtwtMEWQx673U%3D&st=2018-03-23T09:26:24Z&se=2292-01-06T10:26:24Z&sp=r",
              "mediaFileName": "IMG_18-03-23_155619990_1.jpg"
            }
          ]
        },
        {
          "isInvisible": true,
          "title": "ResponseTime",
          "type": "DateTime",
          "options": [],
          "answer": 1521800782956
        }
      ]
    }
  },
  "context": "Any data which is required to be returned in callback",
  "fromUser": "+91xxxxxxxx",
  "fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
  "fromUserName": "Robin Richard",
  "fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}

datos del evento "SurveyResponse"/ "ActionResponse"

Parámetro Tipo Descripción
actionId Id Identificador de esa instancia concreta de Acción de trabajo
groupId Cadena Identificador de grupo
responseId Cadena GUID para identificar esa respuesta
responseDetails Matriz de cadena Matriz de objetos 'responseWithQuestions'
Respondedor Cadena Número de teléfono del respondedor
responderName Cadena Nombre del respondedor
responderProfilePic url url de la imagen de perfil del respondedor
isAnonymous Boolean ¿La respuesta de la encuesta se ha enviado de forma anónima?
isUpdateResponse Boolean El respondedor ha actualizado la respuesta, ya que la respuesta se envió anteriormente.

Detalles del esquema del objeto "responseWithQuestions"

Parámetro Tipo Description
title Cadena Título de la pregunta
type Cadena QuestionType
opciones Matriz Lista de opciones aplicables a preguntas de varias opciones
Respuesta Matriz del objeto Json Respuestas
isInvisible Boolean ¿Está oculta la pregunta de la interfaz de usuario?

Respuesta de webHook de ejemplo para "SurveyResponse" "ActionResponse"

{
  "objectId": "8c2950-9be8-45d6-97f5-bb7013930027",
  "objectType": "Group",
  "eventType": "SurveyResponse",
  "eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
  "data": {
   "actionId": "920f9802-62dafb-9bc2-8d3ba5c43609",
    "groupId": "8c291050-9be8-4d6-97f5-bb7013930027",
    "responseId": "420e9ef0-2a6d-405-a2bf-2688648ce79a",
    "isUpdateResponse": false,
    "responder": "+91xxxxxxxxx",
    "responderName": "Robin Richard",
    "responderProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-f391-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg",
    "isAnonymous": false,
    "responseDetails": {
      "responseWithQuestions": [
        {
          "title": "1",
          "type": "Text",
          "options": [],
          "answer": "1"
        },
        {
          "title": "2",
          "type": "AttachmentList",
          "options": [],
          "answer": [
            {
              "mediaUrl": "https://cdn.inc-000.kms.osi.office.net/att/9841be297131449fba1123ec8545ab30fa72c2017555ba4bcd4ac18d5f7850b4.jpg?sv=2015-12-11&sr=b&sig=Egd4wDmAfGrIoklLj70SrV7D3QtwtMEWQx673U%3D&st=2018-03-23T09:26:24Z&se=2292-01-06T10:26:24Z&sp=r",
              "mediaFileName": "IMG_18-03-23_155619990_1.jpg"
            }
          ]
        },
        {
          "isInvisible": true,
          "title": "ResponseTime",
          "type": "DateTime",
          "options": [],
          "answer": 1521800782956
        }
      ]
    }
  },
  "context": "Any data which is required to be returned in callback",
  "fromUser": "+91xxxxxxxx",
  "fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
  "fromUserName": "Robin Richard",
  "fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}

datos del evento "MemberAdded" / "MemberRemoved"

Parámetro Tipo Descripción
member Cadena Número de teléfono del miembro agregado
memberName Cadena Nombre del miembro agregado
type Cadena Rol de pertenencia del miembro agregado
memberProfilePic url dirección URL de la imagen de perfil del asignado

Respuesta de webHook de ejemplo para 'MemberAdded' /'MemberRemoved'

{
  "objectId": "8c2950-9be8-45d6-97f5-bb7013930027",
  "objectType": "Group",
  "eventType": "JobResponse",
  "eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
  "data": {
    "member": "+91xxxxxxxx",
    "memberName": "Jan Decker",
    "memberProfilePic": "https://mobileonlyapps.blob.core.windows.net/polymer-7ebb8d90e1324b5cbd61d1e10a30ada7/bbac582a4364860679d40fda7c6b.jpg",
    "type": "Member"
  },
  "context": "Any data which is required to be returned in callback",
  "fromUser": "+91xxxxxxxx",
  "fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
  "fromUserName": "Robin Richard",
  "fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}