Vai al contenuto
TurnitPass
SviluppatoriAPI v1Ottieni una chiave API
Sfoglia la documentazione

SviluppatoriNotifiche

Indirizzare avvisi di account, fatturazione e API a un responsabile chiaro

Le notifiche sono una superficie operativa: saldo basso, attività delle chiavi, cambiamenti di fatturazione, errori API e aggiornamenti di prodotto devono raggiungere il titolare dello spazio di lavoro.

REST API v1

La tua piattaforma

Panoramica

spazio di lavoro
POSTinternal event
per account
forma dell’avviso
internal event
{
  "type": "low_word_balance",
  "workspace_id": "user_workspace",
  "words_remaining": 2858,
  "action_url": "/dashboard#workspace-billing"
}

Note

01

Saldo basso

Avvisare i team prima che humanizer o detector restino senza parole.

02

Eventi di chiave

Mostrare creazione, revoca e fallimenti di autenticazione sospetti.

03

Aggiornamenti di prodotto

I cambiamenti per gli sviluppatori sono nel changelog pubblico.

Modello di avvisi

Le notifiche devono corrispondere a un rischio operativo reale

1

Cambiamenti di saldo

Avvisa il titolare quando le parole rimanenti possono bloccare i job di produzione.

2

Ciclo di vita della chiave

Notifica alla creazione o revoca di una chiave, o se aumentano i fallimenti di autenticazione.

3

Eventi di fatturazione

Inoltra upgrade riusciti, pagamenti falliti, rinnovi e cambiamenti del portale.

4

Compatibilità API

Usa le voci del changelog per nuovi endpoint, campi di risposta e cambi di limite documentati.

Canali di avviso

Cosa deve includere ogni messaggio

Poche parole
Saldo e pianoIncludi parole rimanenti, piano e un link a fatturazione o prezzi.
Chiave creata
Nome e oraIncludi etichetta e timestamp, mai il token in chiaro.
Problema di pagamento
Azione di fatturazioneCollega alla fatturazione dello spazio di lavoro e al portale dopo l’accesso.
Cambio API
Link docsPunta alla sezione esatta della reference o del changelog.
Nota di implementazione. Questa pagina documenta il modello di notifiche. L’invio e-mail si collega quando dominio mittente, casella di supporto e preferenze di account sono pronti.
Poi collegalo al tuo flusso di lavoro.Continua a leggere