Documentation Index

Fetch the complete documentation index at: https://docs.turbo360.com/llms.txt

Use this file to discover all available pages before exploring further.

Configuration

  • 3 minute(s) read
Prev Next

Overview

The Configuration screen in Business Activity Monitoring (BAM) provides the connection details your integration components need to send tracking events to the BAM API. It shows the Function App URL, API key, and individual API endpoint URLs for the Push Model (Custom Logging type) environment associated with your organization.

Business value

Instrumenting an integration to send BAM tracking events requires the correct endpoint URLs and authentication credentials. The Configuration screen surfaces all of these in one place, eliminating the need to retrieve them from the Azure portal or contact an administrator. Having accurate connection details reduces setup errors and speeds up initial instrumentation of new Logic Apps, Function Apps, or API Management policies.

How it works

The Configuration screen is organized into two tabs:

  • Connection details — the Function App URL and API key used by your integration connectors (Logic Apps custom connector, .NET library, APIM proxy) and the individual API endpoint URLs for direct HTTP calls.
  • Storage details — the Azure SQL Database and Storage Account connection information associated with this BAM environment. See Storage management for all storage operations.

The Function App URL and API key are generated when the BAM environment is deployed. They do not change unless the environment is redeployed. Each endpoint URL is derived from the Function App URL and the API key, and is ready to copy directly into your integration configuration.

Steps

Use the following steps to access and copy your BAM connection details. Navigate to Business Activity Monitoring > Settings (gear icon) > Configuration to get started.

Access connection details

Connection details provides the credentials and endpoints needed to instrument your integrations.

  1. Select the Connection details tab.
  2. Copy the Function App URL — used as the host URL in the Logic Apps custom connector and the .NET library.
  3. Copy the Api Key — used as the authentication credential alongside the Function App URL.

The API endpoints section provides ready-to-use URLs for direct HTTP calls to the BAM Function App. Two authentication methods are supported:

Method How to pass the key
Query parameter Append ?code=<ApiKey> to the endpoint URL
HTTP header Pass the key as the x-functions-key request header

The following endpoints are available:

Endpoint Purpose
Start transaction Initiates a new transaction instance and records the first stage
Checkpoint Updates the status of an existing stage or transaction
Checkpoint with correlation Correlates a stage to an existing transaction using tracked property values

Access storage details

Storage details shows the Azure SQL Database and Storage Account associated with this BAM environment, along with connection strings and the Patch database option.

Select the Storage details tab to view connection strings and storage configuration. For procedures — including updating connection strings, configuring the purge batch size, patching the database, and purging blob data — see Storage management.

Limitations

  • The Configuration screen is available in the Push Model (Custom Logging type) only. Pull Model (Data Queries) environments do not use a Function App and do not expose this screen.
  • The Function App URL and API key are read-only in this view. To rotate the API key, you must do so directly in the Azure Function App resource in the Azure portal.
  • Connection details are scoped to the BAM organization group shown in the left panel. If you have multiple BAM groups, verify you are viewing the correct group before copying credentials.

Troubleshooting

  1. Integration is sending events but no transaction instances appear in BAM
    Cause: The Function App URL or API key copied from Configuration may be incorrect or truncated.
    Fix: Return to Settings > Configuration > Connection details and recopy both values. Ensure no trailing spaces were included when pasting into the integration component.

  2. Start transaction endpoint returns 401 Unauthorized
    Cause: The API key is being passed in the wrong location — either missing from the query parameter or not included as the x-functions-key header.
    Fix: Confirm which authentication method your integration uses. Pass the key either as ?code=<ApiKey> in the URL or as x-functions-key in the request header — not both simultaneously.

  3. Configuration screen is not accessible
    Cause: The user may not have the required BAM role, or the BAM environment has not yet been deployed.
    Fix: Confirm the BAM environment has been set up under Settings > Getting started. If the environment is deployed, request a role assignment with the appropriate BAM permission from your administrator.

  4. Function App URL shown in Configuration does not match the deployed Azure resource
    Cause: The BAM environment may have been redeployed or the Function App URL updated without refreshing the Configuration screen.
    Fix: Refresh the BAM module in Turbo360. If the URL still does not match, contact your administrator to verify the BAM deployment status.

Related articles