TypeHop
Скачать

Разработчикам · Zapier

Справочник по API TypeHop для Zapier

У приложения TypeHop в Zapier один триггер, New Dictation. Он использует четыре эндпоинта ниже и получает одно событие. Всё передаётся как JSON по HTTPS. Скачать спецификацию OpenAPI 3.1.

Аутентификация

Каждый запрос содержит отдельный ключ Zapier в виде Bearer-токена. Ключ принадлежит одному пользователю в одном рабочем пространстве. Создавайте и отзывайте ключи на typehop.com/zapier/connect. Рабочему пространству нужен тариф с webhooks (Pro или выше).

Базовый URL
https://api.typehop.com/v1/zapier
Заголовок
Authorization: Bearer thp_zap_<64 hex characters>
Ошибки
Ответы не из семейства 2xx возвращают { "error": "<message>" } и никогда не кэшируются.

Проверка ключа

GEThttps://api.typehop.com/v1/zapier/auth

Подтверждает, что ключ действителен и рабочее пространство может использовать webhooks. Возвращает название рабочего пространства, которое Zapier показывает как подпись подключения.

Используется в: Проверка аутентификации

Ответ · 200

{
  "accountLabel": "Acme workspace"
}

Ошибки

  • 401 Ключ отсутствует, неверно сформирован, недействителен или отозван.
  • 403 Тариф рабочего пространства не включает webhooks (Pro или выше), либо подписка неактивна.

Список недавних диктовок

GEThttps://api.typehop.com/v1/zapier/notes

Десять самых недавних диктовок владельца ключа в этом рабочем пространстве, сначала новые. Zapier использует их как тестовые данные при создании Zap.

Используется в: Триггер New Dictation (performList)

Ответ · 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"
    }
  ]
}

Ошибки

  • 401 Ключ отсутствует, неверно сформирован, недействителен или отозван.
  • 403 Тариф рабочего пространства не включает webhooks (Pro или выше), либо подписка неактивна.

Подписка Zap

POSThttps://api.typehop.com/v1/zapier/subscriptions

Регистрирует REST hook Zapier. Принимаются только HTTPS-URL на hooks.zapier.com. Повторная подписка с тем же URL возвращает существующую подписку. Каждая подписка учитывается в лимите webhooks тарифа.

Используется в: Триггер New Dictation (performSubscribe)

Тело запроса

{
  "targetUrl": "https://hooks.zapier.com/hooks/standard/123/abc/"
}

Ответ · 201

{
  "id": "5d1f2c4e-8a1b-4f8e-9a77-3d2f6c1b0e21"
}

Ошибки

  • 400 Некорректный JSON, либо targetUrl не является HTTPS-URL на hooks.zapier.com.
  • 401 Ключ отсутствует, неверно сформирован, недействителен или отозван.
  • 403 Тариф рабочего пространства не включает webhooks (Pro или выше), либо подписка неактивна.
  • 403 Достигнут лимит webhooks для тарифа.
  • 413 Тело запроса больше 4 КБ.

Отписка Zap

DELETEhttps://api.typehop.com/v1/zapier/subscriptions/{id}

Удаляет подписку, созданную с этим ключом. Неизвестные ID обрабатываются без ошибки, поэтому повторная отписка безопасна.

Используется в: Триггер New Dictation (performUnsubscribe)

Ответ · 204

Без тела.

Ошибки

  • 400 ID не является UUID.
  • 401 Ключ отсутствует, неверно сформирован, недействителен или отозван.

Событие note.transcribed

Когда диктовка готова, TypeHop отправляет POST на каждый подписанный hook. Заголовки включают x-talktome-event и x-talktome-event-id (note.transcribed:<note id>). Неудачные доставки повторяются с нарастающей задержкой; ID заметки остаётся прежним, поэтому дубликаты можно отбрасывать по нему.

{
  "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"
  }
}

Триггер Zapier выдаёт четыре поля: id, text (очищенный текст), createdAt и source.

Тестирование без Mac

  1. Войдите на typehop.com/zapier/connect и создайте ключ Zapier.
  2. В Zapier подключите TypeHop с этим ключом, выберите New Dictation и включите Zap.
  3. Вернитесь на страницу подключения, запишите короткую диктовку в браузере или введите тестовую заметку и нажмите Send to my Zaps.

Zap сработает через несколько секунд. Вопросы: support@typehop.com. Страница ключей: https://typehop.com/zapier/connect.

Other products from us:SmashSend·TidySupport·SuperBuilder·Inbounter·Blossu·KnowledgeSDK