v1

latestOpenAPI 3.0.12026-07-26123145.1 KB

Webhooks

Webhook - Cuando un usuario se da de baja (opt-out)

Este endpoint debe ser implementado en TU servidor (por ejemplo: https://tudominio.com/webhooks/on-optout). Treble llamará a este webhook cuando un usuario decida darse de baja o salir de la conversación. Debes configurar la URL de este webhook en el panel de administración de Treble.

post/webhooks/on-optout

Request body

country_codestring required

Código de país del usuario

cellphonestring required

Número de teléfono del usuario sin el código de país

session_idstring required

ID de la sesión del usuario

conversation_idinteger required

ID de la conversación

sent_atstring date-time required

Fecha y hora en que se envió la pregunta

sent_textstring required

Texto enviado al usuario

reason'OPTOUT' required

Razón de la salida del usuario, en este caso 'OPTOUT' para indicar que el usuario decidió darse de baja

Example request

{
  "question": {
    "type": "closed"
  }
}

Response

Respuesta para actualizar o agregar información a la sesión

object required

Objeto JSON con la nueva información que será reemplazada o agregada a la sesión para uso futuro. El servicio debe responder en menos de 10 segundos.