Webhooks

Los webhooks permiten que tus integraciones ejecuten una acción en respuesta a eventos que ocurren con tus evaluaciones o preguntas y respuestas.

Eventos disponibles

Evento	Disparo	Campos
review	Se realiza una nueva evaluación de producto	evaluaciones de producto
review-update	Se actualiza una evaluación (se envían fotos, recibe una respuesta, se publica o se elimina, etc.)	evaluaciones de producto
store-review	Se realiza una nueva evaluación de la tienda	Evaluaciones de la tienda
store-review-update	Se actualiza una evaluación de la tienda (recibe una respuesta, se publica o se elimina, etc.)	Evaluaciones de la tienda

Configurando el webhook

Actualmente, la configuración de los webhooks la realiza nuestro equipo de soporte. Solo necesita enviar un correo electrónico a [email protected] o ponerse en contacto con su especialista en éxito del cliente con la siguiente información:

• Endpoint que recibirá las notificaciones
• Una clave secreta que se utilizará para validar que la información proviene de nuestro sistema (se recomienda un mínimo de 64 caracteres)
• Qué eventos serán enviados a este endpoint

tip

Nuestros webhooks siempre envían la información a través del método HTTP POST, con el payload en formato JSON.

Payload del webhook

{
    "key": "8f6df519a2125946820bc34a561164c2",
    "action": "review",
    "data": {
       "status":"sent",
       "_id":"65a0519a796e57c44eddfb3b",
       "created":"2024-01-11T20:37:46.019Z",
       "customer":"konfidency",
       "sku":"9",
       "name":"Tony S",
       "text":"Me encantó el producto.",
       "rating": 5,
        "helpful": 4,
        "unhelpful": 0,
        "verified": false,
        "recommended": true
    }
}

Campos

campo	descripción	tipo de datos
key	clave secreta	string
action	tipo de evento, según tabla	string
data	información del objeto (evaluación, pregunta)	object

Detalles de los eventos

Campos de datos de webhooks de evaluación de producto

campo	descripción	tipo de datos
_id	ID único de la evaluación	string
status	status de la evaluación, normalmente será "enviado" en este momento	string
created	fecha de envío de la evaluación	string (fecha en formato ISO-8601)
userId	ID del usuario que realizó la evaluación	string
name	nombre del cliente que hizo la evaluación	string
sku	SKU del producto	string
rating	número de estrellas otorgado por el usuario al producto	integer
text	texto de evaluación del cliente	string
recommended	indica si el cliente calificó el producto positivamente	boolean
verified	indica si el cliente es un comprador verificado	boolean
helpful	cantidad de personas que consideraron útil la evaluación.	integer
unhelpful	Cantidad de personas que no consideraron útil la evaluación.	integer
pictures	fotos enviadas con la evaluación	array

Campos de datos de webhooks de evaluación de tienda

campo	descripción	tipo de datos
_id	ID único de la evaluación	string
status	status de la evaluación, normalmente será "enviado" en este momento	string
created	fecha de envío de la evaluación	string (fecha en formato ISO-8601)
userId	ID del usuario que realizó la evaluación	string
name	nombre del cliente que hizo la evaluación	string
rating	número de estrellas otorgado por el usuario al producto	integer
text	texto de evaluación del cliente	string
verified	indica si el cliente es un comprador verificado	boolean
helpful	cantidad de personas que consideraron útil la evaluación.	integer
unhelpful	Cantidad de personas que no consideraron útil la evaluación.	integer