Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Umami

Privacy-focused, open-source web analytics.

CategoryBusiness Intelligence
Authenticationcustom
Version0.3.0
Published scopes0 published scopes
Last updatedSeptember 24, 2026

Overview

Connect Umami with Flows360

Privacy-focused, open-source web analytics.

Use the Umami connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 7 actions and 2 triggers.

Available actions

  • Get Website Stats
  • Get Website Metrics
  • Get Active Visitors
  • Get Pageviews
  • Send Event
  • List Websites
  • Custom API Call

Available triggers

  • New Event
  • New Session

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Umami
  • Package: @activepieces/piece-umami@0.3.0
  • Exact artifact digest: sha256:88801d1d04c67d6391ba6d0870dd41ddb76c576b52e415eaae8adc113f8e319f
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

CUSTOM AUTH, SECRET TEXT. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Get Website Stats (get_website_stats), Returns a summary of visitors, pageviews, bounce rate, and average visit duration for a date range. Classification: read.
  • Get Website Metrics (get_website_metrics), Returns a ranked list for a chosen metric category (e.g. top pages, browsers, or countries) over a date range. Classification: read.
  • Get Active Visitors (get_active_visitors), Returns the number of people currently browsing a website in real time. Classification: read.
  • Get Pageviews (get_pageviews), Returns pageview and session counts over time, broken down by hour, day, week, month, or year. Classification: read.
  • Send Event (send_event), Records a custom event or pageview on a website. Leave the event name blank to track a plain pageview. Classification: read.
  • List Websites (list_websites), Returns all websites tracked in your Umami account. Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • New Event, polling.
  • New Session, polling.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

Authenticationcustom
Supported objects9
Supported actions7
Triggers2

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • Instance URL Required
  • Username Required
  • Password Required · protected credential
connection_2 · custom
  • Umami Cloud (API Key) Required · protected credential

Supported objects

ObjectReadWriteNotes
Get Website Stats Yes No Returns a summary of visitors, pageviews, bounce rate, and average visit duration for a date range.
Get Website Metrics Yes No Returns a ranked list for a chosen metric category (e.g. top pages, browsers, or countries) over a date range.
Get Active Visitors Yes No Returns the number of people currently browsing a website in real time.
Get Pageviews Yes No Returns pageview and session counts over time, broken down by hour, day, week, month, or year.
Send Event Yes No Records a custom event or pageview on a website. Leave the event name blank to track a plain pageview.
List Websites Yes No Returns all websites tracked in your Umami account.
Custom API Call Yes No Make a custom API call to a specific endpoint
New Event Yes No polling trigger declared by the pinned package.
New Session Yes No polling trigger declared by the pinned package.

Supported actions

Get Website Stats · Read

Returns a summary of visitors, pageviews, bounce rate, and average visit duration for a date range.

get_website_stats · Risk: low · Retry: safe

Inputs

  • websiteId · string · Required, Select the website to use.
  • startDate · string · Required, Beginning of the date range.
  • endDate · string · Required, End of the date range.
Get Website Metrics · Read

Returns a ranked list for a chosen metric category (e.g. top pages, browsers, or countries) over a date range.

get_website_metrics · Risk: low · Retry: safe

Inputs

  • websiteId · string · Required, Select the website to use.
  • startDate · string · Required, Beginning of the date range.
  • endDate · string · Required, End of the date range.
  • type · string · Required, Which metric to rank results by.
  • limit · number · Optional, Maximum number of results to return.
Get Active Visitors · Read

Returns the number of people currently browsing a website in real time.

get_active_visitors · Risk: low · Retry: safe

Inputs

  • websiteId · string · Required, Select the website to use.
Get Pageviews · Read

Returns pageview and session counts over time, broken down by hour, day, week, month, or year.

get_pageviews · Risk: low · Retry: safe

Inputs

  • websiteId · string · Required, Select the website to use.
  • startDate · string · Required, Beginning of the date range.
  • endDate · string · Required, End of the date range.
  • unit · string · Optional, How to bucket the results over time.
  • timezone · string · Optional, Timezone for date grouping, e.g. Europe/Paris or America/New_York. Defaults to UTC.
Send Event · Read

Records a custom event or pageview on a website. Leave the event name blank to track a plain pageview.

send_event · Risk: low · Retry: safe

Inputs

  • websiteId · string · Required, Select the website to use.
  • url · string · Required, Path of the page to record, e.g. /pricing.
  • eventName · string · Optional, Name of the custom event, e.g. signup-button-click. Leave blank to record a pageview.
  • eventData · object · Optional, Extra key-value pairs to attach to the event.
  • referrer · string · Optional, URL the visitor came from.
  • title · string · Optional, Title of the page being recorded.
List Websites · Read

Returns all websites tracked in your Umami account.

list_websites · Risk: low · Retry: safe

Inputs

  • limit · number · Optional, Maximum number of websites to return.
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Triggers

New Event · Poll

Triggers when a new custom event is recorded on a website.

Inputs

  • websiteId · string
New Session · Poll

Triggers when a new visitor session is detected on a website.

Inputs

  • websiteId · string

Setup

Setup

  1. Add the Umami connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • Instance URL (baseUrl), required.
  • Username (username), required.
  • Password (password), required; stored as a sensitive connection value.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-umami@0.3.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 7 actions and 2 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Umami connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-umami@0.3.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com