Creating a custom service

    Last updated on:

    In this page

    Overview

    A Custom Service in Log360 Cloud allows you to create secure connections to external services for data integrations, visualizations, and analytics. This feature is useful when you want to bring in log or event data from services that are not natively supported by Log360 Cloud. By defining a custom service, you can configure your own authentication type to communicate with the external system.

    When setting up a custom service, you will also need to provide a Test Connection URL. This is an endpoint exposed by the external application, which can be found in the external application's API documentation. Log360 Cloud uses this URL to verify whether the credentials provided during the connection setup are valid. If the credentials are correct, the connection is established successfully. If not, the system will indicate that the connection has failed.

    Note The Test Connection URL is required only for Basic and API Key authentication. It is not required for OAuth 1.0 and OAuth 2.0, as access tokens are provided by the service. When configuring API requests, enclose the key of any dynamic parameter in curly braces {} so the server can identify and resolve it at runtime.

    This page explains how to create a custom service for each authentication type.

    Steps to create a custom service

    1. Log in to the product console
    2. Go to the Settings tab and select Admin.
    3. Navigate to Management and under Integrations, select Connections.
      Navigating to connections in Log360 Cloud
      Figure 1: Navigating to connections
    4. In the Connections page, click Create Custom Service.
      Creating a custom service
      Figure 2: Creating a custom service
    5. In the Create Custom Service window, enter a Service Name. It is the display name of the service that you want to create.
      Note Display name can contain up to 50 characters.
      Entering a service name
      Figure 3: Entering a service name
    6. (Optional) Click Add Description to include details about the service. Click Save to add the description.
      Adding a description
      Figure 4: Adding a description
    7. Select a Service Category from the dropdown.
      Selecting a service category
      Figure 5: Selecting a service category
    8. In the Help Document URL, specify the documentation link related to the external service.
      Adding help document URL
      Figure 6: Adding help document URL
    9. (Optional) Click Browse to add a Service Icon to visually identify the custom service.
      Adding a service icon
      Figure 7: Adding a service icon
    10. Select an image file from your system and click Open to add it.
      Adding a service icon with agent-based service option
      Figure 8: Adding a service icon
    11. Enable the Agent-based service checkbox if the external application cannot be accessed directly over the internet and requires communication through an agent installed in your network.
      Note If Agent-based service is enabled, only the following authentication types are supported:
      • API Key
      • Basic Authentication
      • OAuth 2
      Enabling agent-based service when creating a custom service
      Figure 9: Enabling agent-based service
    12. Under Authentication Type, choose the required authentication method to connect to the external service:
      Selecting an authentication type when creating a custom service
      Figure 10: Selecting an Authentication type
    13. Click Create or Create and Setup Connection.
      Note The Create option creates only the Custom Service definition. This saves the service name, category, help document URL, icon, and the selected authentication type. This option does not establish a working connection with the external application.

      The Create and Setup Connection option creates the Custom Service and then opens the authentication setup window. In this window, you can provide the connection name, enter authentication values (API Key, Basic Authentication, OAuth1 or OAuth2), fill in parameters and dynamic parameters, and complete authorization. Use this option to configure and activate the connection immediately.

    Using API key

    Note Ensure that you've completed all the steps listed in the Creating a Custom Service section before proceeding.
    1. In the Create Custom Service page, under Authentication Type, select API Key.
      Selecting an authentication type
      Figure 11: Selecting an authentication type
    2. In the Add Authentication Setup window, window will be displayed.
    3. Under Authentication Configuration, choose the Parameter Type from the dropdown. This determines how the API key is sent to the external service.The available options are:
      • Query String - Appends the API key as a query parameter in the URL.
      • Header - Sends the API key as part of the request header.
      • Body - Sends the API key in the request body.
      Selecting parameter type
      Figure 12: Selecting parameter type
    4. Based on the selected parameter type, provide the following details:
      • Parameter Display Name - A user-friendly name for the parameter.
      • Parameter Key - The actual key used in the API request.
      Note You can create up to 50 normal parameters.
      Configuring parameters
      Figure 13: Configuring parameters
    5. Use the Add parameter icon icon next to each row to add a new parameter field, and the Remove parameter icon icon to remove a parameter you no longer need.
    6. (Optional) Enable the checkbox next to Dynamic Parameters if the service requires parameters that change dynamically. Configure the following under Dynamic Parameters:
      • Parameter Display Name - A readable name for the parameter.
      • Parameter Key - The key used in the API call.
      Note
      • Dynamic parameters allow you to use values that can change depending on the user, account, or environment. They act like placeholders in the URL or request.
      • During execution, Log360 Cloud automatically replaces the placeholder with the value provided by the user. You can create up to 10 dynamic parameters.
      Enabling dynamic parameters in Log360 Cloud custom service configuration
      Figure 14: Enabling dynamic parameters
    7. Use the Add icon icon next to each row to add a new parameter field, and the Remove icon icon to remove a parameter you no longer need.
    8. Under Test Connection Configuration, provide the following details:
      • Select the HTTP method (for example, POST or GET) from the dropdown.
      • Enter the Test Connection URL, which is the API endpoint used to validate the connection with the external service.
      Note This is used to include required headers, query parameters, or body values, ensuring that the test request matches the actual API requirements and validates the connection successfully.
      Configuring test connection for custom service
      Figure 15: Configuring test connection
      Customizing test connection inputs
      Figure 16: Customizing test connection inputs
    9. Click Customize Test Connection Inputs to configure additional inputs required for testing the connection.
    10. In the Customize Test Connection Inputs window, configure request parameters as required:
      • Navigate between Header, Query String, and Body tabs based on where parameters need to be added.
      • Select Click Here to add parameters if none are present.
      Adding parameters in test connection configuration
      Figure 17: Adding parameters
      • Provide the following details:
        • Parameter Key - The parameter name used in the request.
        • Parameter Value - The value to be passed during the test connection.
      Configuring parameters for test connection
      Figure 18: Configuring parameters
    11. Use the Add icon icon next to each row to add a new parameter field, and the Remove icon icon to remove a parameter you no longer need.
    12. Click Save to apply the changes.
    13. Click Add to save the authentication configuration.
      Adding the authentication setup
      Figure 19: Adding the authentication
    14. You can click Create to save the custom service profile or click Create and Setup Connection to proceed with establishing the actual connection using this service.
    Note Refer to this section for detailed steps on completing the connection setup using an API key.

    Using basic authentication

    Note Ensure that you've completed all the steps listed in the Creating a Custom Service section before proceeding.
    1. In the Create Custom Service page, under Authentication Type, select Basic Authentication.
      Selecting an authentication type
      Figure 20: Selecting an authentication type
    2. In the Add Authentication Setup - Basic Authentication window will be displayed.
    3. (Optional) Enable the checkbox next to Dynamic Parameters if the service requires parameters that change dynamically. Configure the following under Dynamic Parameters:
      • Parameter Display Name - A readable name for the parameter.
      • Parameter Key - The key used in the API call.
      Note
      • Dynamic parameters allow you to use values that can change depending on the user, account, or environment. They act like placeholders in the URL or request.
      • During execution, Log360 Cloud automatically replaces the placeholder with the value provided by the user. You can create up to 10 dynamic parameters.
      Enabling dynamic parameters
      Figure 21: Enabling dynamic parameters
    4. Use the Add parameter icon icon next to each row to add a new parameter field, and the Remove parameter icon icon to remove a parameter you no longer need.
    5. Under Test Connection Configuration, provide the following:
      • Select the HTTP method (for example, POST or GET) from the dropdown.
      • Enter the Test Connection URL, which is the API endpoint used to validate the connection with the external service.
      Configuring test connection
      Figure 22: Configuring test connection
    6. Click Customize Test Connection Inputs to configure additional inputs required for testing the connection.
      Note This is used to include required headers, query parameters, or body values, ensuring that the test request matches the actual API requirements and validates the connection successfully.
      Customizing test connection inputs
      Figure 23: Customizing test connection inputs
    7. In the Customize Test Connection Inputs window:
      • Navigate between Header, Query String, and Body tabs.
      • Select Click Here to add parameters if none are present.
      Adding parameters
      Figure 24: Adding parameters
      • Provide the following details:
        • Parameter Key - The parameter name used in the request.
        • Parameter Value - The value to be passed during the test connection.
      Configuring parameters
      Figure 25: Configuring parameters
    8. Use the Add icon icon next to each row to add a new parameter field, and the Remove icon icon to remove a parameter you no longer need.
    9. Click Save to apply the changes.
    10. Click Add to save the authentication configuration for the custom service.
      Adding the authentication
      Figure 26: Adding the authentication
    11. You can click Create to save the custom service profile or click Create and Setup Connection to proceed with establishing the actual connection using this service.
    Note Refer to this section for detailed steps on completing the connection setup using basic authentication.

    Using OAuth1

    Note Ensure that you've completed all the steps listed in the Creating a Custom Service section before proceeding.
    1. In the Create Custom Service page, under Authentication Type, select OAuth1.
      Selecting an authentication type in the Create Custom Service page
      Figure 27: Selecting an authentication type
    2. In the Add Authentication Setup window, provide the following fields as required by the external service:
      Note The Parameter Type is set to Header by default for OAuth1. This cannot be modified because OAuth1 always passes authentication parameters through request headers.
      • Consumer Key - A unique identifier issued by the external service to identify your application.
      • Consumer Secret - A confidential key provided by the API service for secure communication.
      • Request Token URL - The endpoint used to generate a temporary request token required to initiate authorization.
      • Authorize URL - The authorization page where users grant permission for the application to access their data.
      • Access Token URL - The endpoint used to exchange temporary credentials for a permanent access token.
      Configuring authentication setup window with OAuth1 fields
      Figure 28: Configuring authentication setup
    3. (Optional) Enable the checkbox next to Dynamic Parameters if the service requires parameters that change dynamically. Configure the following under Dynamic Parameters:
      • Parameter Display Name - A readable name for the parameter.
      • Parameter Key - The key used in the API call.
      Note
      • Dynamic parameters allow you to use values that can change depending on the user, account, or environment. They act like placeholders in the URL or request.
      • During execution, Log360 Cloud automatically replaces the placeholder with the value provided by the user. You can create up to 10 dynamic parameters.
    4. Use the Add icon icon next to each row to add a new parameter field, and the Remove icon icon to remove a parameter you no longer need.
    5. Click Add to save the authentication configuration for the custom service.
      Adding the authentication with dynamic parameters
      Figure 29: Adding the authentication
    6. You can click Create to save the custom service profile or click Create and Setup Connection to proceed with establishing the actual connection using this service.
    Note For detailed steps on completing the connection setup using OAuth 1, refer to this section.

    Using OAuth 2

    OAuth 2 supports multiple grant types, and the setup steps vary depending on the method supported by the external service. The following are the available OAuth 2 configuration types:

    Note Ensure that you've completed all the steps listed in the Creating a Custom Service section before proceeding.

    Using Authorization code with automatic configuration support

    1. In the Create Custom Service page, under Authentication Type, select OAuth 2.
      Selecting an authentication type in the Create Custom Service page
      Figure 30: Selecting an authentication type
    2. In the Add Authentication Setup window, choose how parameters should be passed from the Parameter Type dropdown. The available options are:
      • Query String - Appends the access token as a query parameter in the URL.
      • Header - Sends the access token as part of the request header.
      Selecting parameter type in the Add Authentication Setup window
      Figure 31: Selecting parameter type
    3. From the Grant Type drop-down, select Authorization Code.
      Selecting grant type
      Figure 32: Selecting grant type
    4. From the Configuration Type dropdown, select Auto, as this setup uses automatic configuration.
      Selecting configuration type
      Figure 33: Selecting configuration type
    5. Enter the following OAuth fields:
      • Client ID - Unique identifier issued by the service provider.
      • Client Secret - Secret key issued to your application.
      • Authorize URL - Endpoint where users grant authorization.
      • Access Token URL - Endpoint used to generate the access token.
      • Refresh Token URL (Optional) - Endpoint used to renew an expired access token (if supported).
      • Revoke Token URL (Optional) - Endpoint used to revoke issued tokens (if supported).
      Configuring authentication setup
      Figure 34: Configuring authentication setup
    6. From Client Authentication drop-down, choose how the client credentials should be included.
      Selecting a client authentication method
      Figure 35: Selecting a client authentication method
    7. (Optional) Enter a Scope Display Name for each permission you want to include and in the corresponding Scope field, enter the exact scope value required by the external service, such as read, write, or delete.
      Configuring scopes
      Figure 36: Configuring scopes
    8. Click the Add scope icon icon to add more scope entries as needed.
    9. To remove an entry, click the Remove scope icon icon beside that row.
    10. From Scope Delimiter drop-down, choose how multiple scopes should be separated such as comma, space, or plus.
      Selecting scope delimiters
      Figure 37: Selecting scope delimiters
    11. (Optional) Enable Dynamic Parameters if the authentication flow requires values that change per user or environment. Configure the following under Dynamic Parameters:
      • Parameter Display Name - A readable name for the parameter.
      • Parameter Key - The key used in the API call.
      Note Dynamic parameters act as placeholders and are replaced automatically during execution. You can configure up to 10 dynamic parameters.
    12. Use the Add parameter icon icon next to each row to add a new parameter field, and the Remove parameter icon icon to remove a parameter you no longer need.
    13. Click Add to save the OAuth 2 authentication configuration for the custom service.
      Adding the authentication setup for OAuth 2
      Figure 38: Adding the authentication
    14. Click Create to save only the custom service profile or Click Create and Setup Connection to proceed with establishing the actual connection.
    Note Refer to this section for steps to complete the authorization using OAuth 2 and activate the connection.

    Using OAuth 2 with manual configuration support

    1. In the Create Custom Service page, under Authentication Type, select OAuth 2.
      Selecting an authentication type for custom service
      Figure 39: Selecting an authentication type
    2. In the Add Authentication Setup window, choose how parameters should be passed from the Parameter Type dropdown. The available options are:
      • Query String - Appends the access token as a query parameter in the URL.
      • Header - Sends the access token as part of the request header.
      Selecting a parameter type
      Figure 40: Selecting a parameter type
    3. From the Grant Type drop-down, select Authorization Code.
      Selecting grant type
      Figure 41: Selecting grant type
    4. From the Configuration Type dropdown, select Manual.
      Selecting configuration type
      Figure 42: Selecting configuration type
    5. Enter the following OAuth fields:
      • Authorize URL - Endpoint where users grant authorization.
      • Access Token URL - Endpoint used to generate the access token.
      • Refresh Token URL (Optional) - Endpoint used to renew an expired access token (if supported).
      • Revoke Token URL (Optional)- Endpoint used to revoke issued tokens (if supported).
      Configuring authentication setup
      Figure 43: Configuring authentication setup
    6. From Client Authentication drop-down, choose how the client credentials should be included.
      Selecting a client authentication method
      Figure 44: Selecting a client authentication method
    7. (Optional) Enter a Scope Display Name for each permission you want to include and in the corresponding Scope field, enter the exact scope value required by the external service, such as read, write, or delete.
      Configuring scopes
      Figure 45: Configuring scopes
    8. Click the Add scope icon icon to add more scope entries as needed.
    9. To remove an entry, click the Remove scope icon icon beside that row.
    10. From Scope Delimiter drop-down, choose how multiple scopes should be separated such as comma, space, or plus.
      Selecting scope delimiters
      Figure 46: Selecting scope delimiters
    11. (Optional) Enable Dynamic Parameters if the authentication flow requires values that change per user or environment. Configure the following under Dynamic Parameters:
      • Parameter Display Name - A readable name for the parameter.
      • Parameter Key - The key used in the API call.
      Note Dynamic parameters act as placeholders and are replaced automatically during execution. You can configure up to 10 dynamic parameters.
    12. Use the Add parameter icon icon next to each row to add a new parameter field, and the Remove parameter icon icon to remove a parameter you no longer need.
    13. Click Add to save the OAuth 2 authentication configuration for the custom service.
      Adding the authentication
      Figure 47: Adding the authentication
    14. Click Create to save only the custom service profile or click Create and Setup Connection to proceed with establishing the actual connection.
    Note Refer to this section for steps to complete the authorization using OAuth 2 and activate the connection.

    Using OAuth 2 with manual and automatic configuration support

    1. In the Create Custom Service page, under Authentication Type, select OAuth 2.
      Selecting a parameter type
      Figure 48: Selecting an authentication type

    2. In the Add Authentication Setup window, choose how parameters should be passed from the Parameter Type dropdown. The available options are:
      • Query String - Appends the access token as a query parameter in the URL.
      • Header - Sends the access token as part of the request header.
      Selecting a parameter type
      Figure 49: Selecting a parameter type
    3. From the Grant Type drop-down, select Authorization Code.
      Selecting grant type
      Figure 50: Selecting grant type
    4. From the Configuration Type dropdown, select Manual and Automatic.
      Selecting configuration type
      Figure 51: Selecting configuration type
    Note Follow the steps in this section to complete the remaining setup.

    Using Authorization code with Proof Key for Code Exchange (PKCE)

    1. In the Create Custom Service page, under Authentication Type, select OAuth 2.
      Selecting an authentication type in the Create Custom Service page
      Figure 52: Selecting an authentication type
    2. In the Add Authentication Setup window, choose how parameters should be passed from the Parameter Type dropdown. The available options are:
      • Query String - Appends the access token as a query parameter in the URL.
      • Header - Sends the access token as part of the request header.
      Selecting parameter type in the Add Authentication Setup window
      Figure 53: Selecting parameter type
    3. From the Grant Type drop-down, select Authorization Code with PKCE.
      Selecting grant type from the Grant Type drop-down
      Figure 54: Selecting grant type
    4. From the Configuration Type dropdown, select the configuration method supported by the external service and follow the corresponding steps below:
      Selecting configuration type in the Create Custom Service page
      Figure 55: Selecting configuration type
    Note
    • If you select Auto, refer to this section to complete the remaining setup.
    • If you select Manual, refer to this section to complete the remaining setup.
    • If you select Manual and Automatic, refer to this section to complete the remaining setup.

    Using Authorization code with client credentials

    1. In the Create Custom Service page, under Authentication Type, select OAuth 2.
      Selecting an authentication type in the Add Authentication Setup window
      Figure 56: Selecting an authentication type
    2. In the Add Authentication Setup window, choose how parameters should be passed from the Parameter Type dropdown. The available options are:
      • Query String - Appends the access token as a query parameter in the URL.
      • Header - Sends the access token as part of the request header.
      Selecting a parameter type
      Figure 57: Selecting a parameter type
    3. From the Grant Type drop-down, select Client Credentials. 
      Selecting grant type
      Figure 58: Selecting grant type
    4. Enter the Access Token URL.
    5. From Client Authentication drop-down, choose how the client credentials should be included.
      Selecting a client authentication method
      Figure 59: Selecting a client authentication method
    6. (Optional) Enter a Scope Display Name for each permission you want to include and in the corresponding Scope field, enter the exact scope value required by the external service, such as read, write, or delete.
    7. Click the Add scope icon icon to add more scope entries as needed.
    8. To remove an entry, click the Remove scope icon icon beside that row.
    9. From Scope Delimiter drop-down, choose how multiple scopes should be separated such as comma, space, or plus.
      Selecting a scope delimiter
      Figure 60: Selecting a scope delimiter
    10. (Optional) Select the checkbox next to Dynamic Parameters if the authentication flow requires values that change per user or environment. Configure the following under Dynamic Parameters:
      • Parameter Display Name - A readable name for the parameter.
      • Parameter Key - The key used in the API call.
      Note Dynamic parameters act as placeholders and are replaced automatically during execution. You can configure up to 10 dynamic parameters.
      Enabling dynamic parameters
      Figure 61: Enabling dynamic parameters
    11. Use the Add parameter icon icon next to each row to add a new parameter field, and the Remove parameter icon icon to remove a parameter you no longer need.
    12. Click Add to save the OAuth 2 authentication configuration for the custom service.
    13. Click Create to save only the custom service profile or Click Create and Setup Connection to proceed with establishing the actual connection.
    Note Refer to this section for steps to complete the authorization using client credentials and activate the connection.

    Using multiple authentication

    Some external applications require more than one authentication method to be configured for a single service. Log360 Cloud supports this through multiple authentication, allowing you to combine different authentication types such as API Key, Basic Authentication, OAuth1, or OAuth2 within the same custom service.

    Follow the steps below to configure multiple authentication methods

    1. In the Create Custom Service page, enter a Service Name. It is the display name of the service that you want to create.
      Note Display name can contain up to 50 characters.
      Entering a service name for the custom service
      Figure 62: Entering a service name
    2. (Optional) Click Add Description to include details about the service.
    3. Select a Service Category from the dropdown.
      Selecting a service category from the dropdown
      Figure 63: Selecting a service category
    4. In the Help Document URL, specify the documentation link related to the external service.
      Adding help document URL
      Figure 64: Adding help document URL
    5. (Optional) Upload a Service Icon to visually identify the custom service.
    6. Enable the Agent-based service checkbox if the external application cannot be accessed directly over the internet and requires communication through an agent installed in your network.
    7. Under Authentication Type, click on the first authentication method you want to configure.
      Selecting an authentication type
      Figure 65: Selecting an authentication type
    8. In the Add Authentication Setup window that appears, configure the selected authentication method.
      Note Refer to the respective authentication section in this section
    9. Click Add to save the authentication configuration.
      Adding the authentication when creating a custom service
      Figure 66: Adding the authentication
    10. Repeat steps 7 to 9 to add required authentication methods.
    11. Click Create to save only the custom service profile or Click Create and Setup Connection to proceed with establishing the actual connection.
    Note Refer to this section for steps to complete the authorization and activate the connection.

    Read also

    This page explained how to configure different authentication methods when creating a custom service. For additional setup and management guidance, refer to the following articles: