TF Fiscal
Documentation

Webhooks

Register webhook

Registers or updates the callback URL that receives issuance results and other events.

POST/openapi/v1/webhooks

Requires the token, timestamp and sign signature headers, see Authentication.

One callback configuration per application: webHookId is the application identifier and calling again overwrites the configuration. Registration automatically subscribes to the result events (authorized / denied). Calling the registration again also restores delivery after the consecutive-failure circuit breaker trips.

Parameters

Request body

  • idstringrequired for update

    The webHookId returned on creation; omit to create, include to update (must belong to this application).

  • uristringrequired

    Public https/http URL that receives callbacks.

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

    Only application/json is supported at present.

    Values:application/json
  • tokenstringrequired

    Verification token of your choosing; sent back verbatim in the token request header of every callback so your receiver can verify the origin.

Responses

200

Configuration saved.

  • webHookIdstring

    Configuration identifier (equal to the application identifier). Send it as id to update.

Errors

CodeHTTP
10009033400

Invalid registration: id mismatch or non-JSON contentType.

10001001400

Request field validation failed (one entry per field).

Callback delivery

The platform POSTs to uri with the token header (the value you registered) plus the signature header X-Tffiscal-Signature (HMAC-SHA256 keyed by app_secret), which you may verify optionally. An HTTP 2xx from your receiver counts as delivered; anything else is retried with backoff. The payload shapes of every event are described in Webhooks.

PreviousWebhooksNextFile download