Webhooks

Registrar webhook

Registra ou atualiza a URL de callback que recebe os resultados de emissão e demais eventos.

POST/openapi/v1/webhooks

Requer os cabeçalhos de assinatura token, timestamp e sign, veja Autenticação.

Uma configuração de callback por aplicação: webHookId é o identificador da aplicação e chamar novamente sobrescreve a configuração. O registro subscreve automaticamente os eventos de resultado (autorizado / negado). Chamar o registro de novo também restaura a entrega após o disjuntor de falhas consecutivas.

Parâmetros

Corpo da requisição

idstringobrigatório para atualizar
O webHookId devolvido na criação; omita para criar, informe para atualizar (deve pertencer a esta aplicação).
uristringobrigatório
URL pública https/http que recebe os callbacks.
Exemplo: https://webhook.site/816497e5-0b0e-42a5-abdf-d9040232bf9c
contentTypestringobrigatório
Somente application/json é aceito no momento.
Valores:application/json
tokenstringobrigatório
Token de verificação à sua escolha; devolvido sem alteração no cabeçalho token de todo callback para que o receptor verifique a origem.

Respostas

200

Configuração salva.

webHookIdstring
Identificador da configuração (igual ao identificador da aplicação). Envie em id para atualizar.

Erros

Código	HTTP
10009033	400	Registro inválido: `id` não pertence à aplicação ou `contentType` diferente de JSON.
10001001	400	Falha de validação de campos (uma entrada por campo).

Entrega dos callbacks

A plataforma faz POST para uri com o cabeçalho token (o valor registrado) e o cabeçalho de assinatura X-Tffiscal-Signature (HMAC-SHA256 com o app_secret), cuja verificação é opcional. Um HTTP 2xx do receptor conta como entregue; qualquer outra resposta é reenviada com backoff. Os formatos de carga de cada evento estão em Webhooks.

APP_SECRET='<APP_SECRET>'

API_PATH='/openapi/v1/webhooks'

TIMESTAMP=$(date +%s)

BODY='{

"uri": "https://webhook.site/816497e5-0b0e-42a5-abdf-d9040232bf9c",

"contentType": "application/json",

"token": "dGt6eXp5ZGRra2tzc3Nra2hoaGFha2tha2FhamFoaGFoNzc3Nz"

SIGN=$(printf '%s%s%s%s' "$APP_SECRET" "$API_PATH" "$(printf '%s' "$BODY" | tr -d '\r\n')" "$TIMESTAMP" | md5sum | cut -d' ' -f1)

curl -sS -X POST "https://api.v2.tffiscal.com${API_PATH}" \

-H "Content-Type: application/json" \

-H "token: $APP_SECRET" -H "timestamp: $TIMESTAMP" -H "sign: $SIGN" \

--data-binary "$BODY"