Saltar al contenido principal
Ir al Studio
Configuración del robot

Webhook

Webhook

Un webhook inicia un robot con una llamada de API, que es como Roberty se conecta con otros sistemas, plataformas y scripts. Es la forma habitual de enlazar Roberty con un ERP, un CRM, un formulario web o cualquier cosa capaz de hacer una petición HTTP.

Cómo funciona​

Cada robot puede tener su propio token de webhook secreto. Cuando otro sistema envía una petición a la API de Roberty con ese token, el robot arranca de inmediato. Puedes pasarle datos en la petición y, si quieres, recibir una respuesta personalizada de vuelta.

Generar el token del webhook​

  1. Abre el Designer del robot.
  2. Haz clic en el icono del engranaje (⚙️) para abrir la configuración.
  3. Localiza la sección Token para webhook.
  4. Haz clic en el icono de generar token.
  5. Confirma cuando te lo pida.
  6. Copia el token.
Mantén el token en secreto

El token de webhook otorga la capacidad de disparar el robot de forma remota. No lo compartas con nadie ajeno al desarrollo del robot. Si alguna vez se ve comprometido, genera uno nuevo para invalidar el anterior.

Disparar el robot con POST​

Envía una petición POST al endpoint siguiente, con el token en la cabecera y los argumentos en el cuerpo.

Endpoint:

POST https://api.roberty.app/main/public/webhook/request

Cabecera obligatoria:

x-roberty-token: <tu-token-aquí>

Cuerpo de la petición (JSON):

json
{
  "nome": "Roberty",
  "documento": "123.456.789-00"
}

Los valores del cuerpo llegan al robot como argumentos, accesibles desde campos de expresión o desde código personalizado.

Disparar el robot con GET​

También puedes disparar el robot con una petición GET, pasando los argumentos en la URL.

Ejemplo:

GET https://api.roberty.app/main/public/webhook/request?nome=Roberty&documento=123.456.789-00

La cabecera x-roberty-token sigue siendo obligatoria en un GET.

Seguir la ejecución​

La respuesta a la petición de disparo lleva un identificador llamado webhookCallId. Úsalo para consultar el estado y el resultado de la ejecución:

Endpoint de consulta:

GET https://api.roberty.app/prod/1/customer/robot/webhookResponse/{webhookCallId}

Estados que puede devolver:

EstadoQué significa
WAITINGEl robot sigue en ejecución y aún no ha devuelto una respuesta.
DONELa ejecución terminó con una respuesta personalizada.

Devolver una respuesta personalizada​

Para que el robot envíe datos de vuelta a quien lo disparó, añade al flujo la acción Responder webhook. Devuelve un objeto con lo que quieras dentro.

Ejemplo de respuesta:

json
{
  "response": { "status": "procesado", "codigo": "NF-00123" },
  "status": "DONE"
}

Sin esa acción, consultar el webhookCallId devuelve WAITING mientras el robot se ejecuta.

Siguientes pasos​