Ejemplos de Payloads de Eventos

Estos ejemplos deben ser utilizados como referencia para desarrollar y validar la integración con los webhooks de B2Chat. Asegúrate de probar exhaustivamente cada evento para asegurar que tu sistema pueda manejar los datos correctamente.

Cierre de Chat:

{
   "specversion":"1.0",
   "type":"io.b2chat.chat.closed",
   "source":"https://app.b2chat.io/events/chat", //origen del evento 
   "id":"{{uuid}}", //identificador del evento, source + id seran unicos para cada evento distinto
   "time":"2018-04-05T17:31:00Z", //ISO 8601, tiempo en el que sucedió el evento
   "data":{ // información sobre el chat cerrado
      "chat_id":"0384fd61-98a3-4e0e-a475-bffbeb5c575f",
      "status":"CLOSED",
      "department":"Rastreo",
      "alias":"Whatsapp2",
      "created_at":"2024-01-02 11:17:37Z", //ISO 8601
      "opened_at":"2024-01-02 11:17:37Z",
      "picked_up_at":"2024-01-02 11:17:48Z",
      "closed_at":"2024-01-10 16:33:45Z",
      "responded_at":"2024-01-02 12:17:48Z",
      "duration":"08:05:16:07",
      "is_agent_available":true,
      "viewer_url":"https://app.b2chat.io/viewer/0384fd61-98a3-4e0e-a475-bffbeb5c575f/051b4c01-d8fa-4df6-ae90-b6c555c719a4",
      "tags":[
         "calidad",
         "entregado",
         "prospecto"
      ],
      "agent":{
         "email":"moises@b2chat.io",
         "name":"support_b2chat_21",
         "username":"support_b2chat_21"
      },
      "contact":{
         "id":8887980,
         "identification":"123456789",
         "name":"Moises C",
         "email":"Moises@mail.com",
         "mobile_number":"+574123021322",
         "phone_number":"123456789",
         "custom_attributes":[
            {
               "attribute_name":"Asesor",
               "attribute_value":"Moises"
            },
            {
               "attribute_name":"Observación",
               "attribute_value":"ABCDEF"
            },
            {
               "attribute_name":"Referido por",
               "attribute_value":"Peter"
            }
         ],
         "tags":[
            {
               "name":"Cliente VIP",
               "assigned_at":1707483120
            },
            {
               "name":"Clientes Europa",
               "assigned_at":1706884864
            }
         ]
      }
   }
}

Envío Manual de Chats y Contactos:

{
   "specversion":"1.0",
   "type":"io.b2chat.chat.shared",
   "source":"https://app.b2chat.io/events/chat", //origen del evento 
   "id":"{{uuid}}", //identificador del evento, source + id seran unicos para cada evento distinto
   "time":"2018-04-05T17:31:00Z", //ISO 8601, tiempo en el que sucedió el evento
   "data":{ // información sobre el chat cerrado
      "chat_id":"0384fd61-98a3-4e0e-a475-bffbeb5c575f",
      "status":"RESPONSE_AGENT",
      "department":"Rastreo",
      "alias":"Whatsapp2",
      "created_at":"2024-01-02 11:17:37Z", //ISO 8601
      "opened_at":"2024-01-02 11:17:37Z", //ISO 8601
      "picked_up_at":"2024-01-02 11:17:48Z", //ISO 8601
      "closed_at":"", //ISO 8601
      "responded_at":"2024-01-02 12:17:48Z", //ISO 8601
      "duration":"",
      "is_agent_available":true,
      "viewer_url":"https://app.b2chat.io/viewer/0384fd61-98a3-4e0e-a475-bffbeb5c575f/051b4c01-d8fa-4df6-ae90-b6c555c719a4",
      "tags":[
         "calidad",
         "entregado",
         "prospecto"
      ],
      "agent":{
         "email":"moises@b2chat.io",
         "name":"support_b2chat_21",
         "username":"support_b2chat_21"
      },
      "contact":{
         "id":8887980,
         "identification":"123456789",
         "name":"Moises C",
         "email":"Moises@mail.com",
         "mobile_number":"+574123021322",
         "phone_number":"123456789",
         "custom_attributes":[
            {
               "attribute_name":"Asesor",
               "attribute_value":"Moises"
            },
            {
               "attribute_name":"Observación",
               "attribute_value":"ABCDEF"
            },
            {
               "attribute_name":"Referido por",
               "attribute_value":"Peter"
            }
         ],
         "tags":[
            {
               "name":"Cliente VIP",
               "assigned_at":1707483120
            },
            {
               "name":"Clientes Europa",
               "assigned_at":1706884864
            }
         ]
      }
   }
}

Selección de Botones QR en Templates:

{
    "specversion": "1.0",
    "type": "io.b2chat.template.responded",
    "source": "https://app.b2chat.io/events/template", //origen del evento"id" : "{{uuid}}", //identificador del evento, source + id seran unicos para cada evento distinto
    "time": "2018-04-05T17:31:00Z", //ISO 8601, tiempo en el que sucedió el evento
    "data": { //información sobre el botón y template presionado
        "templateSending": {
            "sentAt": "2024-01-02 12:17:48",//Fecha en la que se envió el broadcast
            "from": "+57300xxxxxxx",
            "to": {
                "email": "Moises@mail.com",
                "id": 123456789,
                "identification": "123456789",
                "mobileNumber": "+574123021322",
                "name": "Moises C",
                "phoneNumber": "123456789",
                "address": "",
                "country": null,
                "city": "",
                "company": ""
            },
            "template": {
                "name": "templatename",
                "body": "ABCDEF",
                "headerUrl": "http://www.africau.edu/images/default/sample.pdf",
                "buttonUrlSuffix": "template",
                "values": [
                    "Agent John",
                    "Contact Mark"
                ]
            }
        },
        "response": {
            "sentAt": "2024-01-02 12:17:48",//cuando el usuario le da clic
            "respondedOption": "text with response selected" 
        }
    }
}

No dudes en ponerte en contacto con nuestro equipo de soporte para cualquier pregunta o asistencia adicional que necesites en la configuración y uso de los webhooks.

Last updated