Typesense integration

What it does

The Typesense integration lets your agency stand up and maintain typo-tolerant search on a client's data without writing glue code. Connect a Typesense cluster once and your workflows can create and delete collections, push documents into the index as records change upstream, retrieve documents by id, and run faceted search queries with filtering and sorting. A polling trigger watches a collection on a fixed interval so workflows can react to newly indexed documents even though Typesense does not push webhooks.

Connect a Typesense account

1. Open your workspace in TaskJuice and navigate to Connections.
2. Choose Typesense and click Connect.
3. In a new tab, open the Typesense Cloud dashboard for the client's cluster (or the admin UI of a self-hosted cluster).
4. Copy the cluster URL. On Typesense Cloud this is the nearest-node hostname under Cluster Configuration, shaped like https://{cluster-id}.a1.typesense.net. For self-hosted clusters use your origin (for example, https://search.example.com).
5. Generate or copy an API key scoped to the actions you want TaskJuice to perform. In Typesense Cloud, keys live under Cluster, API Keys. On self-hosted clusters, create one with POST /keys using the admin key.
6. Paste both values into TaskJuice and save the connection.

To rotate the API key later, mint a new one in Typesense, swap it into the TaskJuice connection, and the next run will pick it up.

Triggers

• typesense/search-poll polls a collection on a fixed interval, runs the configured query, and emits one activation per cycle with one record per hit returned since the previous watermark. Use it with a created_at:>{{watermark}} filter clause to react to newly indexed documents.

Actions

• typesense/create-collection creates a new collection from a schema definition with field names, types, and optional default sorting field.
• typesense/retrieve-collection fetches a collection's schema and current document count by name.
• typesense/delete-collection permanently removes a collection and every document it holds.
• typesense/index-document writes a single document into a collection with selectable write modes: create, upsert, update, or emplace.
• typesense/retrieve-document fetches one document from a collection by its id.
• typesense/search-documents runs a faceted search with query string, query_by fields, optional filter_by, sort_by, and facet_by clauses, paginated via page and per_page.

Known limitations

• Typesense does not push webhooks for indexed-document events, so reacting to new documents requires the search-poll trigger. Polling intervals shorter than 60 seconds are rejected at the workflow level.
• The search action caps per_page at 250 hits, matching the Typesense engine limit.
• Collection names cannot be reused for a few seconds after typesense/delete-collection returns, because the cluster propagates the deletion asynchronously.
• Typesense Cloud clusters in different regions use different nearest-node hostnames; each TaskJuice connection points at one cluster URL, so connect a separate Typesense connection per region.