# Hoko Hoko is a link attribution platform for creating branded short links, tracking clicks, and connecting leads and sales to the campaigns that produced them. ## Primary Machine-Readable Resources - Full LLM context: https://hoko.to/llms-full.txt - OpenAPI: https://api.hoko.to/openapi.json - MCP endpoint: https://mcp.hoko.to/ - API LLM context: https://api.hoko.to/llms.txt - API full context: https://api.hoko.to/llms-full.txt - Docs LLM context: https://docs.hoko.to/llms.txt - Help LLM context: https://help.hoko.to/llms.txt - Sitemap index: https://hoko.to/sitemap.xml ## API Endpoint Inventory | Method | Path | Scope | Purpose | | --- | --- | --- | --- | | GET | /links | linksRead | List links by id, externalId, tenantId, partnerId, and pagination parameters. | | POST | /links | linksWrite | Create one or more short links. | | PUT | /links | linksWrite | Create or update links; entries with id update, entries without id insert. | | DELETE | /links | linksWrite | Soft-delete one or more links by ID. | | GET | /collections | collectionsRead | List collections by id with pagination. | | POST/PUT/DELETE | /collections | collectionsWrite | Create, upsert, or soft-delete collections. | | GET | /tags | tagsRead | List tags by id with pagination. | | POST/PUT/DELETE | /tags | tagsWrite | Create, upsert, or delete tags. | | GET | /partners | partnersRead | List partners by id with pagination. | | POST/PUT/DELETE | /partners | partnersWrite | Create, upsert, or soft-delete partners. | | GET | /customers | customersRead | List customers by id or externalId with pagination. | | PUT/DELETE | /customers | customersWrite | Update existing customers by id or externalId, or soft-delete customers by id. | | GET | /analytics | analyticsRead | List click analytics by linkId, partnerId, startDate, endDate, and pagination parameters. | | POST | /track/lead | conversionsWrite | Record a lead conversion and upsert the customer. | | POST | /track/sale | conversionsWrite | Record a sale conversion and upsert the customer. | ## Documentation ### Getting Started - [Introduction](https://docs.hoko.to/introduction) Hoko is a modern link attribution platform that empowers you to create branded short links, track conversions end-to-end, and measure marketing performance with precision. - [API Keys](https://docs.hoko.to/api-keys) Create and manage API keys with granular permission scopes. Secure your integrations with the principle of least privilege. - [Authentication](https://docs.hoko.to/authentication) Secure Hoko requests with an authorized credential: an API key, human token, OAuth access token, or authenticated browser session. - [Rate Limits](https://docs.hoko.to/rate-limits) Understand rate limits, monitor your usage, and implement proper retry logic to ensure reliable API access. - [Errors](https://docs.hoko.to/errors) Understand error responses, status codes, and how to handle API errors gracefully in your applications. ### Developer tools - [Hoko CLI](https://docs.hoko.to/cli) Command syntax, authentication inputs, output, and exit codes for the Hoko CLI. ### Links - [Introduction](https://docs.hoko.to/links/introduction) The Links API is the foundation of Hoko, enabling you to create, manage, and track short links programmatically. - [(GET) Get links](https://docs.hoko.to/links/get) Retrieve links from your workspace with flexible filtering options. Filter by link ID, external ID, tenant ID, or partner ID. - [(POST) Create links](https://docs.hoko.to/links/post) Create one or more links in a single request. Each link requires a destination URL and collection ID. - [(PUT) Update/Upsert links](https://docs.hoko.to/links/put) Update existing links or create new ones with upsert operations. Perfect for synchronization scenarios. - [(DELETE) Delete links](https://docs.hoko.to/links/delete) Delete one or more links using soft delete. Historical analytics data is preserved. ### Collections - [Introduction](https://docs.hoko.to/collections/introduction) Organize your links with collections. Collections are essential organizational units that help you structure and manage your link library. - [(GET) Get collections](https://docs.hoko.to/collections/get) Retrieve collections from your workspace. Filter by collection ID or list all collections with pagination. - [(POST) Create collections](https://docs.hoko.to/collections/post) Create one or more collections to organize your links. Each collection requires a name. - [(PUT) Update/Upsert collections](https://docs.hoko.to/collections/put) Update existing collections or create new ones with upsert operations. - [(DELETE) Delete collections](https://docs.hoko.to/collections/delete) Delete one or more collections using soft delete. ### Developers - [Custom API clients](https://docs.hoko.to/custom-api) Connect any HTTPS client to Hoko's unversioned REST API. ### Tags - [Introduction](https://docs.hoko.to/tags/introduction) Create, read, update, and delete tags for categorizing and organizing your links. - [(GET) Get tags](https://docs.hoko.to/tags/get) Retrieve tags from your workspace. Filter by tag ID or list all tags with pagination. - [(POST) Create tags](https://docs.hoko.to/tags/post) Create one or more tags. Each tag requires a name, and color is optional. - [(PUT) Update/Upsert tags](https://docs.hoko.to/tags/put) Update existing tags or create new ones with upsert operations. - [(DELETE) Delete tags](https://docs.hoko.to/tags/delete) Permanently delete one or more tags (hard delete). ### Analytics - [Introduction](https://docs.hoko.to/analytics/introduction) Retrieve click analytics and performance data for your links. Gain insights into traffic patterns, user behavior, and campaign effectiveness. - [(GET) Get analytics](https://docs.hoko.to/analytics/get) Retrieve click analytics and performance data for your links. Filter by link, partner, or date range. ### Integrations - [Connected apps](https://docs.hoko.to/integrations/apps) Read the Apps catalog, connection states, and access rules for Hoko integrations. - [Automation recipes](https://docs.hoko.to/integrations/automation) Create Hoko links from customer-owned automation systems with durable mappings and safe reconciliation. - [Receive link.created webhooks](https://docs.hoko.to/integrations/link-created) Verify Hoko link.created deliveries and record durable, minimized receipts. - [Google Tag Manager attribution template](https://docs.hoko.to/integrations/google-tag-manager) Import Hoko's customer-owned browser attribution template with explicit consent. - [Power Automate](https://docs.hoko.to/integrations/power-platform) Import the private Hoko connector and create links from a Power Automate flow. - [Pipedream (archived)](https://docs.hoko.to/integrations/pipedream) Archived Hoko integration notes for Pipedream Workflows. - [Zapier](https://docs.hoko.to/integrations/zapier) Run the private Hoko link actions in Zapier with API-key authentication. - [Make](https://docs.hoko.to/integrations/make) Run Hoko's private link actions and link.created trigger in Make. - [n8n](https://docs.hoko.to/integrations/n8n) Use Hoko link actions in a private n8n community node. - [Commerce integrations](https://docs.hoko.to/integrations/commerce) Connect commerce providers to Hoko link attribution through the shared engine. - [Social and CMS integrations](https://docs.hoko.to/integrations/social-cms) Build reviewable social and CMS recipes around Hoko's shared engine. - [Reporting integrations](https://docs.hoko.to/integrations/reporting) Send Hoko link and conversion facts to reporting and campaign systems. - [OAuth provider connections](https://docs.hoko.to/integrations/oauth) Configure provider OAuth connections without bypassing the shared Hoko engine. - [Later and Hootsuite](https://docs.hoko.to/integrations/later-hootsuite) Review bounded Later reporting and Hootsuite scheduling contracts. ### Customers - [Introduction](https://docs.hoko.to/customers/introduction) Read, update, and delete customer records used for conversion attribution. - [(GET) Get customers](https://docs.hoko.to/customers/get) Retrieve customers by ID or external ID. Supports pagination and sorting. - [(PUT) Update customers](https://docs.hoko.to/customers/put) Update existing customers by ID or external ID. - [(DELETE) Delete customers](https://docs.hoko.to/customers/delete) Soft-delete existing customers by ID. ### Partners - [Introduction](https://docs.hoko.to/partners/introduction) Create, read, update, and delete partners for attribution tracking and commission management. - [(GET) Get partners](https://docs.hoko.to/partners/get) Retrieve partners by ID. Supports pagination and sorting. - [(POST) Create partners](https://docs.hoko.to/partners/post) Create one or more partners. Each partner requires a name. - [(PUT) Update/Upsert partners](https://docs.hoko.to/partners/put) Update existing partners or create new ones with upsert operations. - [(DELETE) Delete partners](https://docs.hoko.to/partners/delete) Delete one or more partners using soft delete. ### Conversion Tracking - [Introduction](https://docs.hoko.to/track/introduction) Track lead and sale conversion events to connect marketing touchpoints to business outcomes. Automatically create and update customer records with flexible attribution tracking. - [Browser attribution script (analytics.js)](https://docs.hoko.to/track/analytics-js) Persist the clickId from short-link redirects using analytics.js and send it to conversion endpoints. - [Embedded click tracking](https://docs.hoko.to/track/embedded-click) Track a Hoko short-link click from an owned page without redirecting the visitor. - [Track lead events](https://docs.hoko.to/track/lead) - [Track sale events](https://docs.hoko.to/track/sale) ### Webhooks - [Introduction](https://docs.hoko.to/webhooks/introduction) Receive signed workspace events securely in your backend, with a complete event catalog and delivery contract. - [Event catalog](https://docs.hoko.to/webhooks/event-catalog) Browse every workspace event available to Webhooks and Logs, with its scope, action, and exact event name. - [Workspace](https://docs.hoko.to/webhooks/workspace) Workspace lifecycle events and their signed payload contract. - [API key](https://docs.hoko.to/webhooks/api-key) API key lifecycle events and their signed payload contract. - [Link](https://docs.hoko.to/webhooks/link) Link lifecycle and configuration events with their signed payload contract. - [Tag](https://docs.hoko.to/webhooks/tag) Tag lifecycle events and their signed payload contract. - [Partner](https://docs.hoko.to/webhooks/partner) Partner lifecycle events and their signed payload contract. - [UTM template](https://docs.hoko.to/webhooks/utm-template) UTM template lifecycle events and their signed payload contract. - [Collection](https://docs.hoko.to/webhooks/collection) Collection lifecycle and default-state events with their signed payload contract. - [Member profile](https://docs.hoko.to/webhooks/member-profile) Member access and ownership events with their signed payload contract. - [Invitation](https://docs.hoko.to/webhooks/invitation) Invitation lifecycle events and their signed payload contract. - [Invoice](https://docs.hoko.to/webhooks/invoice) Invoice notification events and their signed payload contract. - [Subscription](https://docs.hoko.to/webhooks/subscription) Subscription lifecycle events and their signed payload contract. - [Webhook](https://docs.hoko.to/webhooks/webhook) Webhook endpoint lifecycle events and their signed payload contract. - [Customer](https://docs.hoko.to/webhooks/customer) Customer lifecycle events and their signed payload contract. - [Lead](https://docs.hoko.to/webhooks/lead) Lead events use the same thin, signed webhook payload as every other scope. - [Sale](https://docs.hoko.to/webhooks/sale) Sale events use the same thin, signed webhook payload as every other scope. ### Logs - [Introduction](https://docs.hoko.to/logs/introduction) Read the workspace activity ledger, understand every action and scope, and connect facts to webhook delivery. ## Help ### Help - [Hoko CLI](https://help.hoko.to/cli) Install the Hoko CLI, sign in with OAuth, use API keys in automation, and fix common terminal errors. - [App guides](https://help.hoko.to/apps) Browse Hoko app guides and open the Apps page when you are ready to connect a workspace account. - [Getting started](https://help.hoko.to/getting-started) Create a Hoko account, set up a workspace and collection, and publish your first tracked short link. - [Profile](https://help.hoko.to/profile) Manage your Hoko profile details, email, localization, and account settings from one place. - [Workspaces](https://help.hoko.to/workspaces) Create, switch, rename, transfer, and manage Hoko workspaces while understanding ownership limits. - [Collections](https://help.hoko.to/collections) Organize campaign links into Hoko collections and manage collection-level access and lifecycle. - [Links](https://help.hoko.to/links) Create and manage Hoko short links with slugs, UTM values, QR codes, previews, and eligible link controls. - [Tags](https://help.hoko.to/tags) Create and apply Hoko tags to keep links searchable, filterable, and consistent across campaigns. - [Partners](https://help.hoko.to/partners) Create partner records, associate partners with tracked links, and review partner campaign context. - [UTM templates](https://help.hoko.to/utm-templates) Save reusable Hoko UTM templates for consistent campaign source, medium, name, term, and content values. - [Analytics](https://help.hoko.to/analytics) Review Hoko clicks, recorded leads and sales, referrers, UTM values, devices, locations, tags, and CSV exports. - [Participants](https://help.hoko.to/participants) Invite participants and manage workspace and collection roles, removal, and team-seat limits. - [Access and permissions](https://help.hoko.to/access) Understand workspace and collection roles, feature permissions, and how to change member access. - [API keys](https://help.hoko.to/api-keys) Create scoped Hoko API keys, choose permissions, rotate credentials, and keep server integrations secure. - [Webhooks](https://help.hoko.to/webhooks) Set up signed workspace webhooks, understand manager access, verify receivers, and inspect delivery results. - [Logs](https://help.hoko.to/logs) Browse workspace activity, filter by resource and action, and understand log access, privacy, and delivery states. - [Billing](https://help.hoko.to/billing) Understand Hoko plans, subscription changes, billing status, usage limits, and account billing workflows. - [Storage](https://help.hoko.to/storage) Manage files stored in Hoko, understand upload limits, and troubleshoot storage access and cleanup. - [Security](https://help.hoko.to/security) Protect your Hoko account, API keys, workspace access, and sensitive link workflows with practical controls. ### AI and developer tools - [ChatGPT](https://help.hoko.to/apps/chatgpt) Use Hoko links with ChatGPT and follow this guide. - [Claude](https://help.hoko.to/apps/claude) Use Hoko links with Claude and follow this guide. - [Claude Code](https://help.hoko.to/apps/claude-code) Use Hoko links with Claude Code and follow this guide. - [Cursor](https://help.hoko.to/apps/cursor) Use Hoko links with Cursor and follow this guide. - [VS Code](https://help.hoko.to/apps/vscode) Use Hoko links with VS Code and follow this guide. - [GitHub Copilot](https://help.hoko.to/apps/copilot) Use Hoko links with GitHub Copilot and follow this guide. - [Gemini CLI](https://help.hoko.to/apps/gemini-cli) Use Hoko links with Gemini CLI and follow this guide. - [Windsurf](https://help.hoko.to/apps/windsurf) Use Hoko links with Windsurf and follow this guide. ### Automation - [Zapier](https://help.hoko.to/apps/zapier) Use Hoko links with Zapier and follow this guide. - [n8n](https://help.hoko.to/apps/n8n) Use Hoko links with n8n and follow this guide. - [Make](https://help.hoko.to/apps/make) Use Hoko links with Make and follow this guide. - [Custom MCP](https://help.hoko.to/apps/custom-mcp) Use Hoko links with Custom MCP and follow this guide. - [Custom API](https://help.hoko.to/apps/custom-api) Use Hoko links with Custom API and follow this guide. - [Power Automate](https://help.hoko.to/apps/power-automate) Use Hoko links with Power Automate and follow this guide. ### Commerce - [Shopify](https://help.hoko.to/apps/shopify) Use Hoko links with Shopify and follow this guide. - [Salla](https://help.hoko.to/apps/salla) Use Hoko links with Salla and follow this guide. - [Zid](https://help.hoko.to/apps/zid) Use Hoko links with Zid and follow this guide. - [WooCommerce](https://help.hoko.to/apps/woocommerce) Use Hoko links with WooCommerce and follow this guide. - [BigCommerce](https://help.hoko.to/apps/bigcommerce) Use Hoko links with BigCommerce and follow this guide. - [Adobe Commerce](https://help.hoko.to/apps/adobe-commerce) Use Hoko links with Adobe Commerce and follow this guide. ### Social publishing - [Buffer](https://help.hoko.to/apps/buffer) Use Hoko links with Buffer and follow this guide. - [Sprout Social](https://help.hoko.to/apps/sprout-social) Use Hoko links with Sprout Social and follow this guide. - [Publer](https://help.hoko.to/apps/publer) Use Hoko links with Publer and follow this guide. - [Metricool](https://help.hoko.to/apps/metricool) Use Hoko links with Metricool and follow this guide. - [SocialPilot](https://help.hoko.to/apps/socialpilot) Use Hoko links with SocialPilot and follow this guide. - [Typefully](https://help.hoko.to/apps/typefully) Use Hoko links with Typefully and follow this guide. - [Later](https://help.hoko.to/apps/later) Use Hoko links with Later and follow this guide. - [Hootsuite](https://help.hoko.to/apps/hootsuite) Use Hoko links with Hootsuite and follow this guide. ### CRM and marketing - [HubSpot](https://help.hoko.to/apps/hubspot) Use Hoko links with HubSpot and follow this guide. - [Salesforce](https://help.hoko.to/apps/salesforce) Use Hoko links with Salesforce and follow this guide. - [Klaviyo](https://help.hoko.to/apps/klaviyo) Use Hoko links with Klaviyo and follow this guide. - [Mailchimp](https://help.hoko.to/apps/mailchimp) Use Hoko links with Mailchimp and follow this guide. - [Customer.io](https://help.hoko.to/apps/customerio) Use Hoko links with Customer.io and follow this guide. - [Brevo](https://help.hoko.to/apps/brevo) Use Hoko links with Brevo and follow this guide. ### Content management - [WordPress](https://help.hoko.to/apps/wordpress) Use Hoko links with WordPress and follow this guide. - [Webflow](https://help.hoko.to/apps/webflow) Use Hoko links with Webflow and follow this guide. - [Ghost](https://help.hoko.to/apps/ghost) Use Hoko links with Ghost and follow this guide. ### Payments - [Stripe](https://help.hoko.to/apps/stripe) Use Hoko links with Stripe and follow this guide. ### Analytics - [Google Analytics 4](https://help.hoko.to/apps/ga4) Use Hoko links with Google Analytics 4 and follow this guide. - [Google Tag Manager](https://help.hoko.to/apps/google-tag-manager) Use Hoko links with Google Tag Manager and follow this guide. - [PostHog](https://help.hoko.to/apps/posthog) Use Hoko links with PostHog and follow this guide. - [Segment](https://help.hoko.to/apps/segment) Use Hoko links with Segment and follow this guide. ### Team workflow - [Slack](https://help.hoko.to/apps/slack) Use Hoko links with Slack and follow this guide. - [Microsoft Teams](https://help.hoko.to/apps/microsoft-teams) Use Hoko links with Microsoft Teams and follow this guide. - [Notion](https://help.hoko.to/apps/notion) Use Hoko links with Notion and follow this guide. - [Airtable](https://help.hoko.to/apps/airtable) Use Hoko links with Airtable and follow this guide. - [Google Sheets](https://help.hoko.to/apps/google-sheets) Use Hoko links with Google Sheets and follow this guide.