Développeurs · Zapier
Référence de l’API Zapier de TypeHop
L’app TypeHop sur Zapier propose un seul déclencheur, New Dictation. Elle utilise les quatre points de terminaison ci-dessous et reçoit un seul événement. Tout est en JSON via HTTPS. Télécharger la spécification OpenAPI 3.1.
Authentification
Chaque requête transporte une clé Zapier dédiée comme jeton Bearer. Une clé appartient à un utilisateur dans un espace de travail. Créez ou révoquez des clés sur typehop.com/zapier/connect. L’espace de travail doit avoir une offre incluant les webhooks (Pro ou supérieure).
- URL de base
https://api.typehop.com/v1/zapier- En-tête
Authorization: Bearer thp_zap_<64 hex characters>- Erreurs
- Les réponses non 2xx renvoient
{ "error": "<message>" }et ne sont jamais mises en cache.
Tester une clé
GEThttps://api.typehop.com/v1/zapier/auth
Confirme que la clé est valide et que l’espace de travail peut utiliser les webhooks. Renvoie le nom de l’espace de travail que Zapier affiche comme libellé de la connexion.
Utilisé par : Test d’authentification
Réponse · 200
{
"accountLabel": "Acme workspace"
}Erreurs
401Clé manquante, mal formée, invalide ou révoquée.403L’offre de l’espace de travail n’inclut pas les webhooks (Pro ou supérieure), ou l’abonnement n’est pas actif.
Lister les dictées récentes
GEThttps://api.typehop.com/v1/zapier/notes
Les dix dictées les plus récentes du propriétaire de la clé dans cet espace de travail, de la plus récente à la plus ancienne. Zapier les utilise comme données d’exemple pendant que vous créez un Zap.
Utilisé par : Déclencheur New Dictation (performList)
Réponse · 200
{
"notes": [
{
"id": "a0cf17ac-0c67-49df-a875-05c84063161c",
"cleanedText": "Idea: let teammates share a custom dictionary.",
"startedAt": "2026-11-10T10:00:00.000Z",
"source": "macos"
}
]
}Erreurs
401Clé manquante, mal formée, invalide ou révoquée.403L’offre de l’espace de travail n’inclut pas les webhooks (Pro ou supérieure), ou l’abonnement n’est pas actif.
Abonner un Zap
POSThttps://api.typehop.com/v1/zapier/subscriptions
Enregistre un REST hook Zapier. Seules les URL HTTPS sur hooks.zapier.com sont acceptées. S’abonner deux fois avec la même URL renvoie l’abonnement existant. Chaque abonnement compte dans la limite de webhooks de l’offre.
Utilisé par : Déclencheur New Dictation (performSubscribe)
Corps de la requête
{
"targetUrl": "https://hooks.zapier.com/hooks/standard/123/abc/"
}Réponse · 201
{
"id": "5d1f2c4e-8a1b-4f8e-9a77-3d2f6c1b0e21"
}Erreurs
400JSON invalide, ou targetUrl n’est pas une URL HTTPS hooks.zapier.com.401Clé manquante, mal formée, invalide ou révoquée.403L’offre de l’espace de travail n’inclut pas les webhooks (Pro ou supérieure), ou l’abonnement n’est pas actif.403La limite de webhooks de l’offre a été atteinte.413Corps de requête supérieur à 4 Ko.
Désabonner un Zap
DELETEhttps://api.typehop.com/v1/zapier/subscriptions/{id}
Supprime un abonnement créé avec cette clé. Les ID inconnus réussissent sans bruit, ce qui rend sûr un nouvel essai de désabonnement.
Utilisé par : Déclencheur New Dictation (performUnsubscribe)
Réponse · 204
Aucun corps.
Erreurs
400L’ID n’est pas un UUID.401Clé manquante, mal formée, invalide ou révoquée.
L’événement note.transcribed
Quand une dictée est prête, TypeHop envoie un POST à chaque hook abonné. Les en-têtes incluent x-talktome-event et x-talktome-event-id (note.transcribed:<note id>). Les envois échoués sont réessayés avec un délai croissant ; l’ID de la note reste identique, ce qui permet d’écarter les doublons.
{
"event": "note.transcribed",
"timestamp": "2026-11-10T10:00:04.112Z",
"note": {
"id": "a0cf17ac-0c67-49df-a875-05c84063161c",
"cleanedText": "Idea: let teammates share a custom dictionary.",
"startedAt": "2026-11-10T10:00:00.000Z",
"source": "macos"
}
}Le déclencheur Zapier renvoie quatre champs : id, text (le texte nettoyé), createdAt et source.
Tester sans Mac
- Connectez-vous sur typehop.com/zapier/connect et créez une clé Zapier.
- Dans Zapier, connectez TypeHop avec cette clé, choisissez New Dictation et activez le Zap.
- De retour sur la page de connexion, enregistrez une courte dictée dans le navigateur ou saisissez une note de test, puis appuyez sur Send to my Zaps.
Le Zap s’exécute en quelques secondes. Des questions : support@typehop.com. Page des clés : https://typehop.com/zapier/connect.