Webhook

Es una devolución de llamada HTTP o una petición HTTP POST generada por la notificación de un evento.

Las URL que se configuren deben aceptar solicitudes POST.

POST https://api.jelou.ai/v1/widget/webhooks/

Encabezados

Propiedad	Tipo de dato	Descripción
apikey*	String	Clave API

Cuerpo de la Solicitud

Propiedad	Tipo de dato	Descripción
url*	String	URL del webhook
events*	String[]	Eventos a los que se suscribe

Respuesta exitosa (200: OK):

{
  "message": ["Webhooks de <evento> actualizados correctamente!"],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "webhooks": {
      "<evento>": ["<urls>"]
    }
  }
}

Ejemplo

curl --request POST \
  --url https://api.jelou.ai/v1/widget/webhooks \
  --header 'Content-Type: application/json' \
  --header 'apikey: <apikey>' \
  --data '{
    "url": "<URL válida>",
    "events": [
      "...",
      "<Propiedad-evento>"
    ]
}'

precaución

Actualmente no se soporta autenticación para los webhooks.

Obtener Webhooks

GET https://api.jelou.ai/v1/widget/webhooks/

Parámetros de Consulta

Propiedad	Tipo de dato	Descripción
event	String	Filtrar por evento

Encabezados

Propiedad	Tipo de dato	Descripción
apikey*	String	Clave API

Mensaje correcto (200)

{
  // Response
  "message": ["Webhooks by <event> retrieved succesfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "webhooks": {
      "<event>": ["<urls>"]
    }
  }
}

Ejemplo

curl --request GET \
  --url 'https://api.jelou.ai/v1/widget/webhooks?event=<eventName>' \
  --header 'apikey: <apiKey>'

Borrar Webhooks

'DELETE' 'https://api.jelou.ai/v1/widget/webhooks/'

Encabezados

Propiedad	Tipo de dato	Descripción
apikey*	String	Clave API

Cuerpo de la Solicitud

Propiedad	Tipo de dato	Descripción
url*	String	URL del webhook
event*	String	Evento a eliminar

Respuesta 200: OK

{
  "message": ["Webhooks by <event> deleted succesfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "webhooks": {
      "<event>": ["<urls>"]
    }
  }
}

Ejemplo

curl --request DELETE \
  --url https://api.jelou.ai/v1/widget/webhooks \
  --header 'Content-Type: application/json' \
  --header 'apikey: <apikey>' \
  --data '{
	"url": "<URL valid>",
	"event": "<event-name>"
}'