{"openapi":"3.1.0","info":{"title":"TypeHop Zapier API","version":"1.0.0","description":"Endpoints used by the TypeHop integration on Zapier. Authenticate with a dedicated Zapier key created at https://typehop.com/zapier/connect."},"servers":[{"url":"https://api.typehop.com/v1/zapier"}],"security":[{"zapierKey":[]}],"components":{"securitySchemes":{"zapierKey":{"type":"http","scheme":"bearer","description":"A key that starts with thp_zap_."}},"schemas":{"Note":{"type":"object","required":["id","cleanedText","startedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Stable dictation ID; use it to drop duplicates."},"cleanedText":{"type":"string","description":"The polished dictation text."},"startedAt":{"type":"string","format":"date-time"},"source":{"type":"string","description":"Where the dictation came from: macos, windows or web."}}},"Error":{"type":"object","properties":{"error":{"type":"string"}}}}},"paths":{"/auth":{"get":{"operationId":"testAuth","summary":"Test a key","description":"Confirms the key is valid and the workspace can use webhooks. Returns the workspace name that Zapier shows as the connection label.","responses":{"200":{"description":"Valid key.","content":{"application/json":{"schema":{"type":"object","properties":{"accountLabel":{"type":"string"}}}}}},"401":{"description":"Missing, malformed, invalid or revoked key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"The workspace plan does not include webhooks (Pro or higher), or the subscription is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/notes":{"get":{"operationId":"listNotes","summary":"List recent dictations","description":"The ten most recent dictations of the key owner in that workspace, newest first. Zapier uses them as sample data while you build a Zap.","responses":{"200":{"description":"Recent dictations.","content":{"application/json":{"schema":{"type":"object","properties":{"notes":{"type":"array","items":{"$ref":"#/components/schemas/Note"}}}}}}},"401":{"description":"Missing, malformed, invalid or revoked key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"The workspace plan does not include webhooks (Pro or higher), or the subscription is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/subscriptions":{"post":{"operationId":"subscribe","summary":"Subscribe a Zap","description":"Registers a Zapier REST hook. Only HTTPS URLs on hooks.zapier.com are accepted. Subscribing the same URL twice returns the existing subscription. Each subscription counts toward the plan’s webhook limit.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["targetUrl"],"properties":{"targetUrl":{"type":"string","format":"uri"}}}}}},"responses":{"201":{"description":"Subscribed.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}},"400":{"description":"Invalid JSON, or targetUrl is not an HTTPS hooks.zapier.com URL.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"401":{"description":"Missing, malformed, invalid or revoked key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"The workspace plan does not include webhooks (Pro or higher), or the subscription is not active. Or: The webhook limit for the plan has been reached.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"413":{"description":"Request body larger than 4 KB.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/subscriptions/{id}":{"delete":{"operationId":"unsubscribe","summary":"Unsubscribe a Zap","description":"Removes a subscription created with this key. Unknown IDs succeed silently so a retried unsubscribe is safe.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Unsubscribed."},"400":{"description":"The ID is not a UUID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"401":{"description":"Missing, malformed, invalid or revoked key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}},"webhooks":{"note.transcribed":{"post":{"summary":"A dictation is ready","description":"Sent to every subscribed hook. Headers: x-talktome-event and x-talktome-event-id (note.transcribed:<note id>).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event":{"type":"string","enum":["note.transcribed"]},"timestamp":{"type":"string","format":"date-time"},"note":{"$ref":"#/components/schemas/Note"}}}}}},"responses":{"200":{"description":"Received."}}}}}}