TF Fiscal
Documentación

Webhooks

Registrar webhook

Registra o actualiza la URL de callback que recibe los resultados de emisión y demás eventos.

POST/openapi/v1/webhooks

Requiere las cabeceras de firma token, timestamp y sign, vea Autenticación.

Una configuración de callback por aplicación: webHookId es el identificador de la aplicación y llamar de nuevo sobrescribe la configuración. El registro suscribe automáticamente los eventos de resultado (autorizado / denegado). Llamar de nuevo al registro también restaura la entrega tras dispararse el cortacircuitos por fallos consecutivos.

Parámetros

Cuerpo de la petición

  • idstringobligatorio para actualizar

    El webHookId devuelto en la creación; omítalo para crear, inclúyalo para actualizar (debe pertenecer a esta aplicación).

  • uristringobligatorio

    URL pública https/http que recibe los callbacks.

    Ejemplo: https://webhook.site/816497e5-0b0e-42a5-abdf-d9040232bf9c
  • contentTypestringobligatorio

    Solo se admite application/json por el momento.

    Valores:application/json
  • tokenstringobligatorio

    Token de verificación a su elección; se devuelve sin cambios en la cabecera token de cada callback para que el receptor verifique el origen.

Respuestas

200

Configuración guardada.

  • webHookIdstring

    Identificador de la configuración (igual al identificador de la aplicación). Envíelo como id para actualizar.

Errores

CódigoHTTP
10009033400

Registro inválido: id no coincide o contentType distinto de JSON.

10001001400

Falló la validación de campos (una entrada por campo).

Entrega de los callbacks

La plataforma hace POST a uri con la cabecera token (el valor registrado) más la cabecera de firma X-Tffiscal-Signature (HMAC-SHA256 con el app_secret), cuya verificación es opcional. Un HTTP 2xx del receptor cuenta como entregado; cualquier otra respuesta se reintenta con backoff. Los formatos de carga de cada evento están en Webhooks.

AnteriorWebhooksSiguienteDescarga de archivos