Webhooks

Crear nueva suscripción

POST /v1/webhooks

Este endpoint permite suscribirse a notificaciones de Webhooks. Cuando te suscribes, recibirás notificaciones en una URL especificada y se utilizará una clave secreta para garantizar la seguridad de la comunicación. Para hacer esto, necesitas:

Crear un token secreto para el webhook y guarda el token de forma segura en tu servidor para poder acceder a él posteriormente y validar las notificaciones del webhook.

ℹ️

Este servicio permite crear más de una suscripción manteniendo todos esos webhooks conectados, utilizando diferentes urls, tipos y secrets según sea necesario. Ten en cuenta que si tienes más de una suscripción al mismo url, recibirás más de un mensaje.

Es recomendable solo tener una suscripción, esta opcionalidad permite informar a mas de un sistema a la vez en caso de ser necesario.

ℹ️

Cada notificación recibida incluye una firma que debe verificarse antes de procesarla. Ver Validación de los webhooks.

ParámetrosDescripción
secret_key
  • string
  • Clave secreta para validar las firmas en las notificaciones de webhook. Debe contener como mínimo 8 caracteres, una mayúscula y un carácter especial de este conjunto: !@#$%^&*
notification_url
  • string
  • URL donde se generará el evento de notificación
notification_type
  • array
  • Lista de tipos de eventos a los que deseas suscribirte
  • [OPERATION_CREATED, TAXED_OPERATION_CREATED, ACTION_SEND_EMAIL_OPERATION]

Tipos de notificaciones

  • OPERATION_CREATED: Notificaciones sobre la creación de operaciones con datos básicos.
  • TAXED_OPERATION_CREATED: Notificaciones sobre la creación de operaciones con cálculos impositivos aplicados.
  • ACTION_SEND_EMAIL_OPERATION: Notificación para el envío de comprobante por email.
ℹ️
  • Un notification_type desconocido o un JSON mal formado responde 400 con el mensaje bad request. El servicio también acepta el valor MOCK_OPERATION_CREATED (ver Generar notificación de prueba).
  • La respuesta exitosa es 201 sin body.
  curl --request POST \
    --url https://api.menta.global/api/v1/webhooks \
    --header 'Authorization: Bearer {access_token}' \
    --header 'Content-Type: application/json' \
    --data '{
      "secret_key": "string",
      "notification_url": "string",
      "notification_type": ["OPERATION_CREATED", "TAXED_OPERATION_CREATED"]
    }'

201: Created Sin contenido en el body.

Suscripciones - comercioSuscribir comercio