Creación de Webhooks entrantes

uContact permite la creación de webhooks entrantes para poder realizar acciones personalizadas cuando se ejecuten mediante llamadas HTTP el Webhook específico. Se pueden crear tantos webhooks como se deseen y cada uno se ejecuta llamando a una ruta específica. A su vez, es posible devolver un resultado personalizado, tanto el código de respuesta, cuerpo y headers.

Los Webhooks se crean utilizando el diseñador de flujos de uContact y cada uno tiene un nombre único. Los mismos van a ser ejecutados al realizar una llamada de tipo GET, POST, PUT o DELETE a una ruta en específico. Solo es posible recibir peticiones de tipo “application/json” y “application/x-www-form-urlencoded”.

https://<instancia>.ucontactcloud.com/IntegraChannels/resources/webhook/<nombre del webhook>

Variables disponibles

Al ejecutar un flujo de webhook se setean variables globales disponibles disponibles desde javascript que contienen la información de la petición: método, body y headers.

 

METHOD

El método HTTP de ejecución de la petición. Los valores pueden ser GET, POST, PUT, DELETE

  • type: String

 

BODY

type: Object

En caso de que la request sea del tipo application/json

{ "name": "Daniel", "age": 23 }

 

FORM_PARAMS

En caso de que la request sea del tipo application/x-www-form-urlencoded

  • type: Object

{ "param1": "param1", "param2": "param2" }

 

HEADERS

  • type: Object

{ "Accept": "/" ], "Cache-Control": "no-cache" ], "Connection": "close" ], "User-Agent": "PostmanRuntime/7.26.8" ] }

 

QUERY_PARAMS

Parámetros pasados por la URL del webhook, los mismos son clave - valor.

  • type: Obj

Ejemplo para la solicitud https://(Instancia).ucontactcloud.com/IntegraChannels/resources/webhook/test?phone=123123&name=John

 

Acciones disponibles

Se pueden ejecutar todas las acciones disponibles en forma de actividades en el diseñador, consultas a la base de datos, ejecución de métodos de la API de uContact, inyección de mensajes entrantes y ejecución de javascript.

Respuesta

Si no se utiliza la actividad SetWebhookResponse en el flujo de webhook, por defecto la respuesta será 200 con el body vació. En cambio al utilizarla se puede tener total control de la respuesta producida.