Webhooks
Nuestra API te permite crear, listar y eliminar webhooks sin necesidad de usar la interfaz gráfica.
Autenticación
Todas las peticiones a la API de Webhooks deben ser autenticadas. Para ello, debes incluir tu clave de API en el encabezado Authorization
.
Authorization: Bearer TU_CLAVE_DE_API
Tu Clave de API
Puedes encontrar tu clave de API en tu cuenta, en la sección de API keys.
Listar webhooks
Obtén una lista de todos los webhooks que has creado.
GET /api/webhooks
Ejemplo con cURL
curl -X GET "https://monedapi.ar/api/webhooks" \
-H "Authorization: Bearer TU_CLAVE_DE_API"
Respuesta exitosa (200 OK)
[
{
"id": 1,
"url": "https://miservidor.com/hook",
"type": "USD_BLUE",
"method": "POST",
"enabled": true,
"last_sent": "2025-07-06T10:30:00Z",
"created_at": "2025-07-01T12:00:00Z"
}
]
Crear un webhook
Crea un nuevo webhook para recibir notificaciones.
POST /api/webhooks
Cuerpo de la petición (JSON)
Campo | Tipo | Descripción |
---|---|---|
url | string | Requerido. La URL que recibirá la notificación. |
type | string | Requerido. El evento a escuchar (ej. USD_BNA , USD_BLUE ). |
method | string | Opcional. POST o GET . Por defecto: POST . |
Ejemplo con cURL
`curl -X POST "https://monedapi.ar/api/webhooks" \
-H "Authorization: Bearer TU_CLAVE_DE_API" \
-H "Content-Type: application/json" \
-d '{
"url": "https://miservidor.com/nuevo-hook",
"type": "USD_CCL",
"method": "POST"
}'`;
Respuesta exitosa (201 Created)
[
{
"id": 2,
"url": "https://miservidor.com/nuevo-hook",
"type": "USD_CCL",
"method": "POST",
"enabled": true
}
]
Eliminar un webhook
Elimina un webhook existente de forma permanente.
DELETE /api/webhooks/{webhookId}
Path parameters
Campo | Tipo | Descripción |
---|---|---|
webhookId | number | El ID del webhook que deseas eliminar. |
Ejemplo con cURL
`curl -X DELETE "https://monedapi.ar/api/webhooks/2" \
-H "Authorization: Bearer TU_CLAVE_DE_API"`;
Respuesta exitosa
La API devolverá un código de estado 204 No Content
sin cuerpo de respuesta.
Formato del payload del webhook
Cuando un evento se dispara (por ejemplo, un cambio en la cotización del Dólar BNA), enviaremos una petición a tu URL configurada. El cuerpo de la petición (body
) contendrá un objeto JSON con la siguiente estructura:
Ejemplo de payload
{
"event": "USD_BNA",
"buy": 1215.0,
"sell": 1235.0,
"updated": "2025-07-07T22:10:00.123Z"
}
Descripción de los campos
Campo | Tipo | Descripción |
---|---|---|
event | string | El identificador único del evento que disparó la notificación (ej. USD_BNA). |
buy | number | El precio de compra actualizado. |
sell | number | El precio de venta actualizado. |
updated | string | La fecha y hora en formato ISO 8601 de cuándo se generó esta actualización. |