Crear una suscripción

Nivel de seguridad requerida para este servicio

Medio Medio (accessToken)

Objetivo

Crea una suscripción a un tipo de evento. A partir de ese momento, cada vez que el evento ocurra se envía una notificación POST a la URL indicada.

Antes de llamar a este servicio, generá una clave secreta y guardala de forma segura en tu servidor: la vas a necesitar para validar las notificaciones que recibas.

Request

Method: POST

/external/api/webhooks-subscribe

curl -X POST "https://$env/external/api/webhooks-subscribe" \
    -H 'Authorization: Bearer $YOUR_ACCESS_TOKEN' \
    -H 'Content-Type: application/json' \
    --data '$requestBody'

env: Entorno de la API, como producción o desarrollo.
YOUR_ACCESS_TOKEN: Token obtenido en el servicio de autenticación.
body: JSON con el cuerpo del mensaje. Ver a continuación.

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`secretKey`	string	Sí	Clave secreta con la que se firman las notificaciones. Mínimo 8 caracteres, con al menos una mayúscula y un carácter especial.
`notificationUrl`	string	Sí	URL pública, por HTTPS, donde vas a recibir las notificaciones.
`notificationType`	string	Sí	Tipo de evento al que te suscribís. Uno por suscripción. Ver tipos de evento.

Ejemplo de body request ($requestBody)

JSON

{
    "secretKey": "Un4Cl4ve!Segura",
    "notificationUrl": "https://tu-servidor.com/webhooks/propago",
    "notificationType": "NEW_MONEY_MOVEMENT"
}

Ejemplo de Respuestas:

Responde 200 OK sin cuerpo.

⚠️

El secretKey no se puede recuperar después. Guardalo en tu servidor antes de crear la suscripción: es el único dato con el que vas a poder validar que las notificaciones entrantes son legítimas.

Introducción Dar de baja