Desenvolvedores · Zapier
Referência da API do TypeHop para Zapier
O app TypeHop no Zapier tem um gatilho, New Dictation. Ele usa os quatro endpoints abaixo e recebe um evento. Tudo é JSON via HTTPS. Baixe a especificação OpenAPI 3.1.
Autenticação
Cada requisição leva uma chave exclusiva do Zapier como token Bearer. Uma chave pertence a um usuário em um espaço de trabalho. Crie ou revogue chaves em typehop.com/zapier/connect. O espaço de trabalho precisa de um plano com webhooks (Pro ou superior).
- URL base
https://api.typehop.com/v1/zapier- Cabeçalho
Authorization: Bearer thp_zap_<64 hex characters>- Erros
- Respostas não 2xx retornam
{ "error": "<message>" }e nunca são armazenadas em cache.
Testar uma chave
GEThttps://api.typehop.com/v1/zapier/auth
Confirma que a chave é válida e que o espaço de trabalho pode usar webhooks. Retorna o nome do espaço de trabalho que o Zapier exibe como rótulo da conexão.
Usado por: Teste de autenticação
Resposta · 200
{
"accountLabel": "Acme workspace"
}Erros
401Chave ausente, malformada, inválida ou revogada.403O plano do espaço de trabalho não inclui webhooks (Pro ou superior), ou a assinatura não está ativa.
Listar ditados recentes
GEThttps://api.typehop.com/v1/zapier/notes
Os dez ditados mais recentes do dono da chave nesse espaço de trabalho, do mais novo para o mais antigo. O Zapier os usa como dados de exemplo enquanto você monta um Zap.
Usado por: Gatilho New Dictation (performList)
Resposta · 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"
}
]
}Erros
401Chave ausente, malformada, inválida ou revogada.403O plano do espaço de trabalho não inclui webhooks (Pro ou superior), ou a assinatura não está ativa.
Assinar um Zap
POSThttps://api.typehop.com/v1/zapier/subscriptions
Registra um REST hook do Zapier. Somente URLs HTTPS em hooks.zapier.com são aceitas. Assinar a mesma URL duas vezes retorna a assinatura existente. Cada assinatura conta para o limite de webhooks do plano.
Usado por: Gatilho New Dictation (performSubscribe)
Corpo da requisição
{
"targetUrl": "https://hooks.zapier.com/hooks/standard/123/abc/"
}Resposta · 201
{
"id": "5d1f2c4e-8a1b-4f8e-9a77-3d2f6c1b0e21"
}Erros
400JSON inválido, ou targetUrl não é uma URL HTTPS de hooks.zapier.com.401Chave ausente, malformada, inválida ou revogada.403O plano do espaço de trabalho não inclui webhooks (Pro ou superior), ou a assinatura não está ativa.403O limite de webhooks do plano foi atingido.413Corpo da requisição maior que 4 KB.
Cancelar a assinatura de um Zap
DELETEhttps://api.typehop.com/v1/zapier/subscriptions/{id}
Remove uma assinatura criada com esta chave. IDs desconhecidos têm sucesso silenciosamente, então repetir um cancelamento é seguro.
Usado por: Gatilho New Dictation (performUnsubscribe)
Resposta · 204
Sem corpo.
Erros
400O ID não é um UUID.401Chave ausente, malformada, inválida ou revogada.
O evento note.transcribed
Quando um ditado fica pronto, o TypeHop envia um POST para cada hook assinado. Os cabeçalhos incluem x-talktome-event e x-talktome-event-id (note.transcribed:<note id>). Entregas com falha são repetidas com backoff; o ID da nota permanece o mesmo, então duplicatas podem ser descartadas por ele.
{
"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"
}
}O gatilho do Zapier retorna quatro campos: id, text (o texto revisado), createdAt e source.
Testando sem um Mac
- Entre em typehop.com/zapier/connect e crie uma chave do Zapier.
- No Zapier, conecte o TypeHop com essa chave, escolha New Dictation e ative o Zap.
- De volta à página de conexão, grave um ditado curto no navegador ou digite uma nota de teste e clique em Send to my Zaps.
O Zap roda em poucos segundos. Dúvidas: support@typehop.com. Página da chave: https://typehop.com/zapier/connect.