Aller au contenu
TurnitPass
DéveloppeursAPI v1Obtenir une clé API
Parcourir la documentation

DéveloppeursNotifications

Adresser les alertes de compte, de facturation et d’API au bon responsable

Les notifications sont une surface opérationnelle : solde bas, activité des clés, changements de facturation, erreurs API et mises à jour produit doivent atteindre le titulaire de l’espace de travail.

REST API v1

Votre plateforme

Aperçu

espace de travail
POSTinternal event
lié au compte
forme de l’alerte
internal event
{
  "type": "low_word_balance",
  "workspace_id": "user_workspace",
  "words_remaining": 2858,
  "action_url": "/dashboard#workspace-billing"
}

Notes

01

Solde bas

Prévenir les équipes avant que humanizer ou detector ne manquent de mots.

02

Événements de clé

Rendre visibles création, révocation et échecs d’authentification suspects.

03

Mises à jour produit

Les changements destinés aux développeurs figurent dans le changelog public.

Modèle d’alertes

Les notifications doivent refléter un risque opérationnel réel

1

Changements de solde

Prévenir le titulaire lorsque les mots restants peuvent bloquer des jobs de production.

2

Cycle de vie de la clé

Notifier à la création ou révocation d’une clé, ou si les échecs d’authentification augmentent.

3

Événements de facturation

Transmettre montées d’offre réussies, paiements échoués, renouvellements et changements de portail.

4

Compatibilité API

S’appuyer sur le changelog pour les nouveaux endpoints, champs de réponse et changements de limite documentés.

Canaux d’alerte

Ce que chaque message doit contenir

Peu de mots
Solde et offreIndiquer les mots restants, l’offre et un lien vers la facturation ou les tarifs.
Clé créée
Nom et heureInclure le libellé et l’horodatage, jamais le jeton en clair.
Problème de paiement
Action de facturationLier vers la facturation de l’espace de travail et le portail après connexion.
Changement d’API
Lien docsPointer vers la section exacte de la référence ou du changelog.
Note d’implémentation. Cette page documente le modèle de notifications. L’envoi d’e-mails se branche lorsque le domaine d’expéditeur, la boîte support et les préférences de compte sont prêts.
Ensuite, intégrez-le à votre flux.Continuer la lecture