# Allegro Audience

> Documentation for the Allegro Audience CDP, an open source API-driven customer data platform.

- [Understand every reader. Own every byte.](/index.md): Guides and API reference for Allegro Audience, the open source customer data platform for publishers. Set up your instance, embed the SDK, and call the APIs.


## Developer

- [Developer Platform Overview](/developer.md): How to integrate with the Allegro platform.
- [Browser Settings](/developer/administration/browser-settings.md): Control which browser origins may call the tenant API and how SDK cookies are scoped across your subdomains.
- [Custom Domain](/developer/administration/custom-domain.md): Serve the Allegro SDK and its API from a domain you control instead of the default tenant subdomain.
- [API Authentication](/developer/api/authentication.md): How to create an API key to authenticate REST API requests.
- [Allegro Platform API](/developer/api/landlord/allegro-platform-api.md): Endpoints for platform operators. These routes are served only from the platform host and require a platform-owned API key — organization API keys cannot access them.
- [Platform Health Summary](/developer/api/landlord/platform-health-show.md): Report the pending job count for each configured queue, plus the failed
- [List Tenants](/developer/api/landlord/tenant-index.md): Return every tenant on the platform. Restricted to super admins and only
- [Platform API Access](/developer/api/landlord-access.md): Who can call the Platform API and how to authenticate against it.
- [Allegro Browser SDK API](/developer/api/session/allegro-browser-sdk-api.md): Endpoints used by the Allegro Browser SDK.
- [Record Heartbeat](/developer/api/session/allegro-heartbeat.md): Push the page_view event id onto the tenant's Redis FIFO list with a
- [allegro.interactionEvaluate](/developer/api/session/allegro-interaction-evaluate.md): allegro.interactionEvaluate
- [allegro.interactionEvaluateDebug](/developer/api/session/allegro-interaction-evaluate-debug.md): allegro.interactionEvaluateDebug
- [Entitlement Check](/developer/api/session/audience-entitlement-check.md): Check whether the authenticated member has an active entitlement for the given product slug.
- [List Active Entitlements](/developer/api/session/audience-entitlement-index.md): List all active entitlements for the authenticated audience member.
- [Get a single external profile for the authenticated audience member by provider](/developer/api/session/audience-external-profile-show.md): Get a single external profile for the authenticated audience member by provider
- [Identify Session](/developer/api/session/authentication-identify-session.md): Create or retrieve an audience device session for the given email and device ID.
- [Initiate Checkout](/developer/api/session/checkout-initiate.md): Creates a hosted checkout session for a term and returns the provider URL.
- [Exchange Purchase Token](/developer/api/session/checkout-token-exchange.md): Exchange a one-time allegro_purchase_token for a JWT and entitlement data.
- [Create Event](/developer/api/session/event-create.md): Record a new event with the provided request data.
- [Get Form](/developer/api/session/form-show-by-slug.md): Fetch a form definition by its slug for rendering in the browser. Fields
- [Submit Form](/developer/api/session/form-submit.md): Submit values for a form on behalf of the authenticated audience member.
- [Verifies a Fundraise Up delivery against the connection the request host resolves to and queues it for
processing by its identifiers only. Returns 404 without a connection, 400 (with an error log line) without a
signing secret, for a bad signature, or for a body without an id, type and data.object.id, and 200
otherwise; ping and test events, and events from the mode the connection is not in, are logged and not queued](/developer/api/session/fundraiseup-webhook.md): Verifies a Fundraise Up delivery against the connection the request host resolves to and queues it for
- [Get Interaction](/developer/api/session/interaction-show.md): Retrieve a single interaction by its ID or slug. Published interactions are
- [Request a combined magic link and one-time code](/developer/api/session/magic-link-otp-request.md): Sends a single email containing both a magic sign-in link and a six-digit
- [Request Magic Link](/developer/api/session/magic-link-request.md): Send a magic link email to the provided address for passwordless authentication.
- [Validate Magic Link](/developer/api/session/magic-link-validate.md): Validate a magic link token and authenticate the device session. Only the
- [Request OTP](/developer/api/session/otp-request.md): Email a six-digit one-time passcode for passwordless authentication.
- [Validate OTP](/developer/api/session/otp-validate.md): Validate a six-digit code against the latest unexpired code for the
- [Record Recommendation Click](/developer/api/session/recommendation-click.md): Reports that the reader clicked one served recommendation, keyed to the
- [Get Recommendations](/developer/api/session/recommendation-index.md): Ranked article recommendations for the reader's device, from the
- [Destroy Session](/developer/api/session/session-destroy.md): Log out and delete the current device session. A `logout` event
- [Get Session](/developer/api/session/session-get.md): Retrieve the current authenticated device session details.
- [Update Profile](/developer/api/session/session-profile-update.md): Update the authenticated audience member's own record. Fields the request
- [Refresh Session Token](/developer/api/session/session-refresh.md): Generate a new JWT for the current device session.
- [Delete User Attribute](/developer/api/session/session-user-attribute-delete.md): Clear the authenticated audience member's stored value for a user attribute. The
- [List User Attributes](/developer/api/session/session-user-attribute-index.md): List every user attribute defined for the tenant along with the authenticated
- [Set User Attribute](/developer/api/session/session-user-attribute-set.md): Set the value of a single user attribute for the authenticated audience member.
- [Set User Attributes](/developer/api/session/session-user-attribute-set-many.md): Set the values of several user attributes for the authenticated audience member
- [Exchange Social Login Code](/developer/api/session/social-login-exchange.md): Exchange the one-time `allegro_social_code` a redirect-based social login appends to
- [Get a published template by its slug](/developer/api/session/template-show-by-slug.md): Used by the SDK to resolve `<allegro-template ref='...'>` children.
- [Describe the authenticated identity behind the current request](/developer/api/token/allegro-authenticated-identity.md): A first-party session or a legacy user token returns the user as before.
- [Allegro REST API](/developer/api/token/allegro-rest-api.md): Endpoints that use authenticated user tokens.
- [Get Story Analytics](/developer/api/token/analytics-content-show.md): Returns how one story performed, by its `path` (e.g. `/news/story`), over a `window`:
- [List Analytics Events](/developer/api/token/analytics-event-stream-index.md): Returns the explorer's event stream, newest first, 50 per page. Pass `next_cursor` back as
- [Explore Events](/developer/api/token/analytics-explore-show.md): Returns the Events explorer's chart and breakdown: event counts per type (up to six types,
- [Run Analytics Query](/developer/api/token/analytics-query-store.md): Runs a report definition, the same shape saved reports store, and returns its totals and
- [Get Reader Analytics](/developer/api/token/analytics-reader-show.md): Returns one registered reader's sessions and the event timeline of the selected one, built
- [Get Realtime Analytics](/developer/api/token/analytics-realtime-show.md): Returns the Pulse: `counts` (readers now, last-hour page views and sign-ups, and last-hour
- [List Analytics Reports](/developer/api/token/analytics-report-index.md): Lists the built-in reports, each naming the API endpoint (and `include` section) that returns
- [Run Analytics Report](/developer/api/token/analytics-report-results.md): Runs a saved report and returns it with its result, over its own preset range unless `range`
- [Get Analytics Report](/developer/api/token/analytics-report-show.md): Returns one saved report: its name, description, definition (the same shape `POST
- [Create Analytics Report](/developer/api/token/analytics-report-store.md): Saves a report the whole team can open from Analytics → Reports: a `name`, an optional
- [Get Analytics Schema](/developer/api/token/analytics-schema-show.md): Lists what analytics can be asked for: event types seen in the range (with event, session
- [Get Event Counts](/developer/api/token/analytics-view-event-counts.md): Returns the event count behind each Events view over the range: the numbers on the Events tabs.
- [Get Content Gate Analytics](/developer/api/token/analytics-view-gates.md): Returns `summary` (headline stats, a series by gate type, and gates by type and article) and
- [Get Login Analytics](/developer/api/token/analytics-view-logins.md): Returns headline stats, a daily login series, and logins by member level, device and article.
- [Get Purchase Analytics](/developer/api/token/analytics-view-purchases.md): Returns revenue, purchases and average order against the previous period, with purchases
- [Get Sign-up Analytics](/developer/api/token/analytics-view-sign-ups.md): Returns headline stats, a sign-up series by gate type, the sign-up funnel, and sign-ups by article.
- [Get Time on Site Analytics](/developer/api/token/analytics-view-time-on-site.md): Returns `summary` (headline stats, a daily engaged time series and the session length distribution) and
- [Get Traffic Analytics](/developer/api/token/analytics-view-traffic.md): Returns the page views view: `overview` (headline stats against the previous period, with a
- [List Audience Device Sessions](/developer/api/token/audience-device-session-index.md): Retrieve all device sessions for a given audience member.
- [List Audience Member Events](/developer/api/token/audience-event-index.md): Retrieve a paginated timeline of tracked events for an audience member,
- [Delete Audience Member](/developer/api/token/audience-member-destroy.md): Soft-delete an audience member by their ID.
- [Delete External Profile](/developer/api/token/audience-member-external-profile-destroy.md): Delete the external profile for the given audience member and provider key.
- [List External Profiles](/developer/api/token/audience-member-external-profile-index.md): List all external profiles for the given audience member.
- [Get External Profile](/developer/api/token/audience-member-external-profile-show.md): Get a single external profile for the given audience member by provider key.
- [Upsert External Profile](/developer/api/token/audience-member-external-profile-upsert.md): Create or update an external profile for the given audience member and provider key.
- [Delete Foreign Key](/developer/api/token/audience-member-foreign-key-destroy.md): Remove a foreign key from an audience member by its key name.
- [List Foreign Keys](/developer/api/token/audience-member-foreign-key-index.md): Retrieve all foreign keys associated with an audience member.
- [Create Foreign Key](/developer/api/token/audience-member-foreign-key-store.md): Add a new foreign key to an audience member.
- [List Audience Members](/developer/api/token/audience-member-index.md): Retrieve a paginated list of audience members. Supports filtering by `email`,
- [Patch Audience Member](/developer/api/token/audience-member-patch.md): Partially update an audience member's attributes and meta data. Meta values
- [Get Audience Member](/developer/api/token/audience-member-show.md): Retrieve a single audience member by their ID.
- [Create Audience Member](/developer/api/token/audience-member-store.md): Create a new audience member with the provided attributes and optional meta data.
- [Update Audience Member](/developer/api/token/audience-member-update.md): Fully replace an audience member's attributes and metadata.
- [Delete User Attribute](/developer/api/token/audience-member-user-attribute-delete.md): Clear the given audience member's stored value for a user attribute. The attribute
- [List User Attributes](/developer/api/token/audience-member-user-attribute-index.md): List every user attribute defined for the tenant along with the given audience
- [Set User Attribute](/developer/api/token/audience-member-user-attribute-set.md): Set the value of a single user attribute for the given audience member. The value
- [Revoke Entitlement](/developer/api/token/entitlement-destroy.md): Revoke a specific entitlement from an audience member.
- [List Entitlements](/developer/api/token/entitlement-index.md): Retrieve all entitlements for a given audience member, including their associated resources.
- [Get Entitlement](/developer/api/token/entitlement-show.md): Retrieve a specific entitlement for a given audience member.
- [Create Entitlement](/developer/api/token/entitlement-store.md): Grant a new entitlement to an audience member.
- [Flush Queued Events](/developer/api/token/event-queue-destroy.md): Remove exactly `count` events from the front of the Redis list. The caller
- [List Queued Events](/developer/api/token/event-queue-index.md): Return up to 10,000 events from the front of the Redis list.
- [Flush Queued Heartbeats](/developer/api/token/heartbeat-queue-destroy.md): Remove exactly `count` heartbeats from the front of the Redis list (oldest
- [List Queued Heartbeats](/developer/api/token/heartbeat-queue-index.md): Return up to 10,000 heartbeats from the front of the Redis list.
- [Archive Interaction](/developer/api/token/interaction-management-destroy.md): Soft-delete an interaction. It stops being served and stops being
- [Duplicate Interaction](/developer/api/token/interaction-management-duplicate.md): Copy an interaction — actions, journeys, and trigger mode — into a new
- [Delete Interaction](/developer/api/token/interaction-management-force-destroy.md): Permanently delete an interaction and its revision history. This cannot
- [List Interactions](/developer/api/token/interaction-management-index.md): Retrieve a paginated list of interactions, most recently updated first.
- [Restore Interaction](/developer/api/token/interaction-management-restore.md): Bring an archived interaction back as a draft. It stays unpublished until
- [Get Interaction](/developer/api/token/interaction-management-show.md): Retrieve a single interaction, addressed by its ID or its slug, with its
- [Create Interaction](/developer/api/token/interaction-management-store.md): Create an interaction. A manual interaction needs at least one action; an
- [Unpublish Interaction](/developer/api/token/interaction-management-unpublish.md): Return a published interaction to draft, taking it out of the targeting
- [Update Interaction](/developer/api/token/interaction-management-update.md): Replace an interaction's configuration. Omitting `slug` keeps the current
- [Delete Milestone](/developer/api/token/milestone-destroy.md): Permanently delete a milestone by its ID.
- [List Milestones](/developer/api/token/milestone-index.md): Retrieve milestones, newest date first. Milestones are dated notes shown on analytics charts, optionally
- [Get Milestone](/developer/api/token/milestone-show.md): Retrieve a single milestone by its ID.
- [Create Milestone](/developer/api/token/milestone-store.md): Create a milestone. Leave `property_ids` empty to show it on every property's charts.
- [Update Milestone](/developer/api/token/milestone-update.md): Update a milestone. Omitted fields keep their values; `property_ids` replaces the whole list when given.
- [Request Magic Link](/developer/api/token/passwordless-authentication-request-magic-link.md): Email a magic link to the member for passwordless sign-in, creating the
- [Request OTP](/developer/api/token/passwordless-authentication-request-otp.md): Email a six-digit one-time passcode to the member, creating the audience
- [Validate Magic Link](/developer/api/token/passwordless-authentication-validate-magic-link.md): Redeem a magic link token and authenticate the `device_id` session,
- [Validate OTP](/developer/api/token/passwordless-authentication-validate-otp.md): Check a six-digit code against the latest code issued to `email` on the
- [Delete Product](/developer/api/token/product-destroy.md): Permanently delete a product by its ID.
- [List Products](/developer/api/token/product-index.md): Retrieve all products ordered by most recently created.
- [Get Product](/developer/api/token/product-show.md): Retrieve a single product by its ID.
- [Create Product](/developer/api/token/product-store.md): Create a new product with the provided attributes.
- [Update Product](/developer/api/token/product-update.md): Update the name of an existing product.
- [Get Template](/developer/api/token/template-show.md): Retrieve a single template by its ID.
- [Tenant Health Summary](/developer/api/token/tenant-health-show.md): Report the current tenant's Redis queue depths and the age of the oldest
- [Record Recommendation Click](/developer/api/token/token-recommendation-click.md): Reports a click on one served recommendation, keyed to the
- [List Recommendations](/developer/api/token/token-recommendation-index.md): Ranked article recommendations for a device or article, from the
- [Preview Recommendations](/developer/api/token/token-recommendation-preview.md): Ranked recommendations for a hypothetical reading history, without a
- [@alleyinteractive/allegro-platform](/developer/api-reference.md): Functions
- [Function: createAllegroSDK()](/developer/api-reference/functions/createAllegroSDK.md): createAllegroSDK(config): AllegroSDK
- [Function: enableDebugMode()](/developer/api-reference/functions/enableDebugMode.md): enableDebugMode(): void
- [Function: ensureComponentsLoaded()](/developer/api-reference/functions/ensureComponentsLoaded.md): ensureComponentsLoaded(): Promise\
- [Function: hydrateQueue()](/developer/api-reference/functions/hydrateQueue.md): hydrateQueue(sdk): void
- [Interface: AllegroConfig](/developer/api-reference/interfaces/AllegroConfig.md): Defined in81
- [Interface: AllegroSDK](/developer/api-reference/interfaces/AllegroSDK.md): Defined in135
- [Interface: InteractionActionCookie](/developer/api-reference/interfaces/InteractionActionCookie.md): Defined in222
- [Interface: InteractionActionCss](/developer/api-reference/interfaces/InteractionActionCss.md): Defined in217
- [Interface: InteractionActionJavaScript](/developer/api-reference/interfaces/InteractionActionJavaScript.md): Defined in212
- [Interface: InteractionActionTemplate](/developer/api-reference/interfaces/InteractionActionTemplate.md): Defined in162
- [Interface: InteractionNamespace](/developer/api-reference/interfaces/InteractionNamespace.md): Defined in17
- [Interface: InteractionResponse](/developer/api-reference/interfaces/InteractionResponse.md): Defined in131
- [Interface: InteractionTemplateData](/developer/api-reference/interfaces/InteractionTemplateData.md): Defined in178
- [Interface: MemberEntitlement](/developer/api-reference/interfaces/MemberEntitlement.md): Defined in1351
- [Interface: MemberNamespace](/developer/api-reference/interfaces/MemberNamespace.md): Defined in340
- [Interface: MemberProfile](/developer/api-reference/interfaces/MemberProfile.md): Defined in321
- [Interface: MetersNamespace](/developer/api-reference/interfaces/MetersNamespace.md): Defined in22
- [Interface: MeterUsage](/developer/api-reference/interfaces/MeterUsage.md): Defined in2
- [Interface: PageDataSource](/developer/api-reference/interfaces/PageDataSource.md): Defined in1
- [Interface: PublicPlan](/developer/api-reference/interfaces/PublicPlan.md): Defined in22
- [Interface: PurchaseNamespace](/developer/api-reference/interfaces/PurchaseNamespace.md): Defined in1481
- [Interface: PurchaseTokenExchangeResponse](/developer/api-reference/interfaces/PurchaseTokenExchangeResponse.md): Defined in1514
- [Interface: RecommendationItem](/developer/api-reference/interfaces/RecommendationItem.md): Defined in1234
- [Interface: RecommendationSet](/developer/api-reference/interfaces/RecommendationSet.md): Defined in1253
- [Interface: RecommendationsGetOptions](/developer/api-reference/interfaces/RecommendationsGetOptions.md): Defined in1266
- [Interface: RecommendationsNamespace](/developer/api-reference/interfaces/RecommendationsNamespace.md): Defined in1283
- [Interface: ShowLoginOptions](/developer/api-reference/interfaces/ShowLoginOptions.md): Defined in1361
- [Interface: TenantConfig](/developer/api-reference/interfaces/TenantConfig.md): Defined in15
- [Interface: TrackEventData](/developer/api-reference/interfaces/TrackEventData.md): Defined in274
- [Interface: TrackResponse](/developer/api-reference/interfaces/TrackResponse.md): Defined in303
- [Type Alias: AllegroCallback](/developer/api-reference/type-aliases/AllegroCallback.md): AllegroCallback = (allegro) => void
- [Type Alias: AudienceMember](/developer/api-reference/type-aliases/AudienceMember.md): AudienceMember = object
- [Type Alias: IdentifySessionResponse](/developer/api-reference/type-aliases/IdentifySessionResponse.md): IdentifySessionResponse = object
- [Type Alias: InteractionAction](/developer/api-reference/type-aliases/InteractionAction.md): InteractionAction = InteractionActionTemplate \| InteractionActionComponent \| InteractionActionJavaScript \| InteractionActionCss \| InteractionActionCookie
- [Type Alias: MagicLinkRequestResponse](/developer/api-reference/type-aliases/MagicLinkRequestResponse.md): MagicLinkRequestResponse = object
- [Type Alias: MagicLinkValidateResponse](/developer/api-reference/type-aliases/MagicLinkValidateResponse.md): MagicLinkValidateResponse = object
- [Type Alias: MemberJwtPayload](/developer/api-reference/type-aliases/MemberJwtPayload.md): MemberJwtPayload = object
- [Type Alias: MeterUsageMap](/developer/api-reference/type-aliases/MeterUsageMap.md): MeterUsageMap = Record\
- [Type Alias: SessionResponse](/developer/api-reference/type-aliases/SessionResponse.md): SessionResponse = object
- [Type Alias: SocialLoginResponse](/developer/api-reference/type-aliases/SocialLoginResponse.md): SocialLoginResponse = object
- [Type Alias: UserAttributeValue](/developer/api-reference/type-aliases/UserAttributeValue.md): UserAttributeValue = object
- [Variable: logger](/developer/api-reference/variables/logger.md): const logger: object
- [Web Components](/developer/components.md): Drop-in HTML elements for building audience experiences on your site.
- [BottomDrawer](/developer/components/bottom-drawer.md): Panel that rises from the bottom of the screen without blocking the page, and can collapse to a short bar.
- [ContentGate](/developer/components/content-gate.md): Dialog component that renders immediately and blocks content until dismissed.
- [ContentGateInline](/developer/components/content-gate-inline.md): Inline component that hides article content at a specific position until the reader authenticates.
- [EmailForm](/developer/components/email-form.md): Web component for email subscription with confirmation state.
- [Form](/developer/components/form.md): Renders an admin-composed form of user attributes for the authenticated member to fill out.
- [LoginForm](/developer/components/login-form.md): Web component for magic link and OAuth authentication.
- [Modal](/developer/components/modal.md): Centered dialog with a backdrop, such as a welcome note or an announcement, that the reader closes.
- [Recommendations](/developer/components/recommendations.md): Web component for rendering a list of ranked article recommendations.
- [Quick Start](/developer/getting-started/quick-start.md): Get the Allegro SDK sending custom events from your page in minutes.
- [Alpine State Reference](/developer/guides/alpine-state.md): The shape of the reactive Alpine store and interaction component exposed by the Allegro SDK in every template.
- [Member Authentication](/developer/guides/authentication.md): Authenticate members via the SDK and access user data and entitlements.
- [Magic Links](/developer/guides/authentication/magic-links.md): Passwordless authentication via magic links sent to the user's email.
- [One-Time Codes](/developer/guides/authentication/one-time-codes.md): Passwordless authentication via a six-digit one-time code sent to the user's email.
- [Social Login](/developer/guides/authentication/social-login.md): OAuth authentication with Google, Apple, and Facebook using a popup window, or a full-page redirect on mobile.
- [Event Tracking](/developer/guides/event-tracking.md): Track events with automatic session, device, and page metadata collection.
- [Interactions](/developer/guides/interactions.md): How the SDK evaluates automatically targeted interactions, and the allegro.interaction namespace for manual control.
- [JavaScript Events](/developer/guides/javascript-events.md): Global DOM events dispatched by the Allegro SDK on window.
- [JWT Verification](/developer/guides/jwt.md): Verify Allegro member session JWTs in your own backend or API gateway using the public RS256 signing keys.
- [Local Template Preview](/developer/guides/local-preview.md): Run a local dev server to preview Allegro templates with live reload, field editing, and device breakpoints.
- [MCP Server](/developer/guides/mcp.md): Connect AI clients to your Allegro tenant via the Model Context Protocol.
- [Connecting an MCP Client with OAuth](/developer/guides/mcp-oauth.md): Sign an AI client in to Allegro's MCP server with OAuth instead of an API key.
- [OAuth 2.0](/developer/guides/oauth.md): Sign members in through Allegro and receive their member JWT using the OAuth 2.0 Authorization Code flow with PKCE.
- [Silent sign-in](/developer/guides/oauth-silent-sign-in.md): Find out whether a visitor already has an Allegro session and exchange that for a member token, without sending them through the sign-in page.
- [Page Metadata](/developer/guides/page-metadata.md): How the SDK reads page metadata from JSON-LD structured data on each track() call, and how to customize the field mappings.
- [One-off Purchases](/developer/guides/payment/purchases.md): Initiate Stripe checkout and handle the post-purchase return from the Allegro SDK.
- [Properties](/developer/guides/properties.md): Embed the Allegro SDK for a specific property using its dedicated host, and understand how property hosts route requests.
- [Recommendations](/developer/guides/recommendations.md): Fetch ranked article recommendations for a reader and report clicks on them from the browser.
- [Preview Scenarios](/developer/guides/scenarios.md): Preview templates inside real-world surfaces — built-in article placements and your own custom host pages.
- [Script Tag](/developer/guides/script-tag.md): Add the Allegro SDK to your site with a single script tag.
- [template.json](/developer/guides/template-json.md): The manifest that defines a template's name and editable fields, with a JSON Schema for editor validation.
- [Templates](/developer/guides/templates.md): How Allegro templates render on the page — shadow DOM, Alpine.js context, and available web components.
- [User Attributes](/developer/guides/user-attributes.md): Read and write a signed-in member's profile attributes from the browser.
- [Platform](/developer/platform.md): Configuration and infrastructure guides for operators deploying and maintaining an Allegro instance.
- [Event Queue](/developer/platform/event-streaming/event-queue.md): Redis List-based pipeline for real-time event delivery to external consumers.
- [Heartbeat Queue](/developer/platform/event-streaming/heartbeat-queue.md): Redis List-based pipeline for delivering page-engagement heartbeats to external consumers.
- [Heartbeat Service](/developer/platform/event-streaming/heartbeat-service.md): The standalone service that ingests SDK heartbeats and serves the heartbeat queue API.
- [Audience Member Sync](/developer/platform/integrations/audience-member-sync.md): Staleness-aware, queue-backed sync providers for keeping external audience data fresh on a schedule and on login.
- [Cloudflare OAuth for Allegro Edge](/developer/platform/integrations/cloudflare-edge-oauth.md): Register the platform-wide Cloudflare OAuth client that lets organizations connect their Cloudflare account to Allegro Edge.
- [GitHub Template Sync](/developer/platform/integrations/github-sync.md): Sync templates from a GitHub repository with webhook-triggered automatic updates.
- [Stripe Webhook Setup](/developer/platform/integrations/stripe-webhooks.md): Configure the platform-wide Stripe webhook so Allegro can fulfill purchases reliably.
- [Emergency Banner](/developer/platform/operations/emergency-banner.md): Show a platform-wide emergency banner across every tenant and landlord dashboard, with a message and an optional details link.
- [Health Checks](/developer/platform/operations/health-checks.md): Monitor queue depth, backlog age, and failed jobs with Allegro's tenant and platform health endpoints.
- [Mail Forwarding](/developer/platform/operations/mail-forwarding.md): Redirect a tenant's outgoing email to a single inbox in place of its real recipients, configured platform-wide and overridden per tenant.
- [Maintenance Mode](/developer/platform/operations/maintenance-mode.md): Freeze a single tenant during planned maintenance so all of its web and API requests return HTTP 503 until you turn it back off.
- [Queue Management](/developer/platform/operations/queue-management.md): Allegro's background jobs run on Laravel Cloud managed queues, which autoscale workers to the waiting work and scale to zero when idle.
- [JWT Key Management](/developer/platform/security/jwt.md): How Allegro signs member session JWTs with per-tenant RSA keys, and how to rotate and retire those keys in production.
- [Custom Domain](/developer/platform/setup/custom-domain.md): Provision domains at your hosting provider from a per-tenant inventory, then assign one as the tenant's own domain or to a property.
- [Feature Flags](/developer/platform/setup/feature-flags.md): Toggle platform-wide feature flags that apply across every tenant from the Allegro Admin.
- [Tenants](/developer/platform/setup/tenants.md): Create and provision tenants from the Allegro Admin of a self-hosted Allegro instance.
- [SDK Reference](/developer/sdk-reference.md): Complete reference for the Allegro JavaScript SDK — methods, types, and return values.
- [Webhook Events Reference](/developer/webhooks/events.md): Every subscribable webhook event, grouped by entity, with payload shapes and examples.
- [Webhooks](/developer/webhooks/overview.md): Receive real-time HTTP notifications when events occur in your Allegro organization.

## Getting Started

- [Allegro Audience](/getting-started.md): Allegro Audience is an open source audience engagement platform for tracking events, authenticating readers, and delivering dynamic content.

## Product

- [Activity Log](/product/administration/activity-log.md): Review a record of what changed across your organization, who changed it, and when.
- [Branding](/product/administration/branding.md): Apply your organization's logo, colors, fonts, and shape to every embedded Allegro component through a global design system that cascades into per-component overrides.
- [Captcha](/product/administration/captcha.md): Score sign-in attempts with Google reCAPTCHA v3 so automated traffic cannot create audience members or trigger login emails at your expense.
- [Connected apps](/product/administration/connected-apps.md): See and disconnect the AI clients you've signed in to Allegro's MCP server.
- [Geolocation](/product/administration/geolocation.md): Connect your own IP geolocation provider to target visitors by region, city, or ZIP / postal code.
- [OAuth clients](/product/administration/oauth-clients.md): Register and manage the partner integrations that can sign your members in through Allegro.
- [Permissions](/product/administration/permissions.md): Who can do what in your Allegro organization.
- [Properties](/product/administration/properties.md): Run multiple properties under a single Allegro organization, each with its own domain, CORS, cookie, and email settings.
- [Settings](/product/administration/settings.md): Configure your organization and personal preferences in Allegro.
- [Sign-in page](/product/administration/sign-in-page.md): Add header and footer copy — typically Terms of Service and Privacy Policy links — to your organization's hosted OAuth sign-in page.
- [Users](/product/administration/users.md): Manage the team members who have access to your Allegro organization.
- [Analytics](/product/analytics.md): Watch what readers are doing right now on the Pulse, and find your way around the Analytics section.
- [Analytics API and MCP](/product/analytics/api-and-mcp.md): Read the same analytics the Analytics pages show from your own scripts over the API, or from an AI assistant over the MCP server.
- [Analytics Assistant](/product/analytics/assistant.md): Ask questions about your audience in plain words; the assistant answers, changes the page to show the answer, and drafts reports for you to save.
- [Events](/product/analytics/events.md): Explore every tracked event, filter and break it down, and read the dedicated views for page views, time on site, gates, sign-ups, logins, and purchases.
- [Milestones](/product/analytics/milestones.md): Mark dates worth remembering, like a launch or a press mention, so they appear on every analytics chart that includes them.
- [Reports](/product/analytics/reports.md): Find the built-in analytics views, and build saved reports your whole team can open and pin to the Pulse.
- [Audience](/product/audience.md): Browse and manage the members in your Allegro organization.
- [Audience Member Authentication](/product/audience/authentication.md): How audience members authenticate with magic links, one-time codes, and OAuth providers.
- [Forms](/product/audience/forms.md): Compose your user attributes into forms members fill out on your site to update their own profile.
- [Segments](/product/audience/segments.md): Build saved groups of known members from engagement, membership, and giving rules, see their size as you edit, and export them as CSV.
- [User Attributes](/product/audience/user-attributes.md): Define the typed profile fields members can store on their own audience record.
- [Command Palette](/product/command-palette.md): Jump to any page, run quick actions, switch sites, and search your audience, interactions, templates, and forms from one keyboard-driven search box.
- [Content](/product/content.md): Browse the stories Allegro has cataloged from your site, check whether each one is ready for recommendations, and export the catalog.
- [Recommendation Engines](/product/content/engines.md): Create named recommendation engines that blend reading history, categories, geography, and trending stories with your own weights.
- [Recommendation Explorer](/product/content/explorer.md): Build a hypothetical reader from the stories they've read and see what a recommendation engine would show them.
- [Story View](/product/content/story.md): See how a single story performed since it was published, against the rest of your site.
- [Dashboard](/product/dashboard.md): Real-time KPIs, audience growth, login activity, and content engagement for your Allegro organization.
- [Email Templates](/product/email-templates.md): Customize the transactional emails Allegro sends to your members.
- [Entitlements](/product/entitlements.md): Entitlements are a way to manage access to products and services. They can be used to grant or revoke access to specific features, content, or services based on the user's subscription or purchase history.
- [Offers and Plans](/product/entitlements/offers.md): Present members with subscription and purchase options that grant access to products through entitlements.
- [Payment Provider](/product/entitlements/payment-provider.md): Connect a payment provider to enable paid offers and checkout for your audience members.
- [Plan Fields](/product/entitlements/plan-fields.md): Define extra fields your team fills in on every plan, such as a seat limit or a tier label.
- [Purchases](/product/entitlements/purchases.md): Browse, search, refund, and export the purchases made across your plans.
- [Exports](/product/exports.md): Generate and download CSV exports of your purchases, audience members, and segments.
- [Fundraise Up](/product/integrations/fundraise-up.md): Connect Fundraise Up so donations and recurring plans build a donor profile on each audience member.
- [Salesforce Marketing Cloud](/product/integrations/salesforce-marketing-cloud.md): Connect Salesforce Marketing Cloud to subscribe members to newsletters, sync their data to data extensions, power the Subscription Center and fire a welcome journey.
- [Interactions](/product/interactions.md): On-site experiences that combine templates, JavaScript, cookies, and CSS, delivered either by your own code or by automatic visitor targeting.
- [A/B Tests](/product/interactions/ab-tests.md): Split visitors into variants and target each variant from any interaction's journeys.
- [Actions](/product/interactions/actions.md): Configure what an Interaction does on the page, where it applies, and when it runs.
- [Assistant](/product/interactions/assistant.md): Draft and rewrite journeys from a plain-language description with the AI assistant.
- [Cohorts](/product/interactions/cohorts.md): Save a set of targeting conditions once and reuse it across any interaction's journeys.
- [Targeting Conditions](/product/interactions/conditions.md): Reference for every attribute, operator, and value format available in journey conditions.
- [Journeys](/product/interactions/journeys.md): Target Interactions automatically by describing who should see which actions with ordered journeys of conditions.
- [Meters](/product/interactions/meters.md): Count how many pages a visitor reads, target journeys on that count, and show it in your templates.
- [Potential Reach](/product/interactions/potential-reach.md): See how many visitors each journey would have reached, based on the last 30 days of analytics data, while you edit.
- [Priority](/product/interactions/priority.md): Rank automatic interactions and decide which others stay hidden when several match the same page view.
- [Report](/product/interactions/report.md): See how often an automatic interaction ran, broken down by journey and by day, with CSV and PDF downloads.
- [Revisions](/product/interactions/revisions.md): Full version history and rollback for templates and other content.
- [Templates](/product/interactions/templates.md): Reusable content containers combining HTML, JavaScript, and CSS.
- [Testing Journeys](/product/interactions/testing.md): Simulate a visitor inside the editor, or debug every automatic Interaction live on your own site.