Configure

Webhooks

Cómo configurar webhooks en el API de TAXO WS para la notificación de eventos.

Configurar webhooks es esencial para recibir notificaciones automáticas sobre eventos de extracción, errores, o resúmenes de los mismos a través del API de Taxo WS. Aquí te mostramos cómo registrar un nuevo webhook.

Es crucial que la URL del webhook sea una pública y capaz de recibir eventos POST con cuerpo en formato JSON. Esta configuración permite que Taxo WS envíe notificaciones eficientes y seguras directamente a tu sistema o aplicación.

Código de Ejemplo

Javascript
const axios = require('axios');
let data = JSON.stringify({
  "url": "https://tu.webhook/path"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://staging-api.taxo.ws/webhooks',
  headers: { 
    'x-api-key': 'tu_api_key', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Ejemplo webhook

JSON
{
  "event": "extraction.inprogress",
  "organizationId": "d52eec2a-5e29-41be-8ee1-c8afd2b8f9fd",
  "createdAt": "2024-04-27T12:24:59.048Z",
  "model": "extraction",
  "data": {
    "id": "b467bf71-0816-4202-8d3d-827f13f92ace",
    "taskId": "staging_1de458d6a03f474dad47768998f4e6ee",
    "taxpayerId": "c85f1521-2130-4048-bba0-f5892368c6b1",
    "taxpayerIdentification": "1702369214001",
    "organizationId": "d52eec2a-5e29-41be-8ee1-c8afd2b8f9fd",
    "status": "COMPLETED",
    "taskType": "PURCHASE.RETENTION",
    "createdAt": "2024-04-27T12:15:41.000Z",
    "updatedAt": "2024-04-27T12:24:59.040Z",
    "startDownloadAt": "2024-04-26",
    "retries": 1,
    "extractionType": "SUMMARY",
    "content": {
      "summary": [
        {
          "type": "Comprobante de Retención",
          "value": [
            "2404202407176001321000120590020011861860000000012",
            "0104202407179028338000120010160024839510248395111",
            "0104202407179199236900120011000000018181234567812",
            "2404202407179028338000120010160025029060250290616"
          ]
        }
      ],
      "countDocuments": 4
    },
    "triggerMethod": "API"
  }
}

Copyright © 2024