Upnify Documentación API
Inicia aquí · /integraciones/webhooks

Integraciones

Registrar un webhook

POST/integraciones/webhooks

Registra la URL a la que Upnify enviará avisos de un suceso. Requiere un token de integración con permisos de administración. Usa un tkSuceso válido y una URL que acepte el método configurado. parametros, constantes y encabezados se envían como texto JSON. La respuesta incluye el identificador del webhook creado.

Parámetros

NombreTipoValidaciónDescripción
tokenStringRequeridoEncabezado: Token completo de la integración, incluido su prefijo si lo tiene. Conserva el valor proporcionado por Upnify.
tkSucesoStringRequeridoCuerpo: Identificador del suceso que disparará el aviso.
urlStringRequeridoCuerpo: URL completa que recibirá el aviso.
nombreStringCuerpo: Nombre para identificar el webhook.
metodoStringCuerpo: Método HTTP del aviso.
parametrosStringCuerpo: Objeto JSON serializado con el mapeo de parámetros del aviso.
constantesStringCuerpo: Objeto JSON serializado con los valores fijos del aviso.
encabezadosStringCuerpo: Objeto JSON serializado con los encabezados del aviso. No publiques credenciales.
restringidoIntegerCuerpo: Indicador de restricción del webhook.
idZapierStringCuerpo: Identificador de suscripción de Zapier. Al enviarlo, se configura un aviso POST restringido.

Respuesta

NombreTipoDescripción
codeIntegerCódigo de resultado. El valor 0 indica que la operación terminó sin error.
msgStringMensaje de resultado. Su texto puede variar.
detailsArray<Object>Arreglo con los datos de la operación.
details[].tkWebhookStringIdentificador del webhook creado.

Solicitud

Registrar el receptor de un suceso

curl --request POST \
  --url https://api.upnify.com/integraciones/webhooks \
  --header 'Accept: application/json' \
  --header 'token: P01AP00000000-0000-4000-8000-000000000001' \
  --header 'Content-Type: application/json' \
  --data '{
  "tkSuceso": "00000000-0000-4000-8000-000000000001",
  "nombre": "Aviso de ejemplo",
  "url": "https://example.com/webhooks/upnify",
  "metodo": "POST"
}'

Respuesta

Webhook registrado (HTTP 200)

JSON
[
  {
    "code": 0,
    "msg": "Ok",
    "details": [
      {
        "tkWebhook": "00000000-0000-4000-8000-000000000001"
      }
    ]
  }
]