Freshservice - Create Service Request per Asset

Freshservice - Create Service Request per Asset creates a Freshservice service request for a service catalog item for each asset that matches a selected query or is selected on an asset page. Axonius links each created service request to the source asset and adds it to the Axonius Tickets module.

Use this action for:

  • Assets returned by the selected query or assets selected on the relevant asset page.

Note

All Freshservice field names are case sensitive. To check a field name, fetch the asset with a curl command and check the RAW data in Axonius. See Service Desk API for Developers | Freshservice.

See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.

When accessing an enforcement action using the API, you must use the backend form of field names.

Use the Syntax Helper to find the correct name. In the enforcement action, enable Configure Dynamic Values and select Syntax Helper.

Note

Required Fields

These fields must be configured to run the Enforcement Action.

  • Action name - The name of this Enforcement Action. The system sets a default name. You can change the name.
  • Configure Dynamic Values (optional) - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.
  • Use stored credentials from the Freshservice adapter - Select this option to use credentials from an existing Freshservice adapter connection. By default, the first connection is selected.
  • When you select this option, the Select Adapter Connection drop-down becomes available. Select the adapter connection to use for this Enforcement Action.

Note

To use this option, you must successfully configure a Freshservice adapter connection.

  • Service Catalog item Display ID - Enter the display ID of the Freshservice service catalog item for which the service request is created.
  • Quantity - Enter the number of items to request. The default is 1.
  • Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Working with Axonius Compute Nodes.

Additional Fields

These fields are optional.

  • Requester Email - Enter the email address of the requester who creates the service request. If you leave this field blank, the service request is created as the user that owns the API key.
  • Requested for - Enter the email address of the user the service request is created for.
  • Workspace ID - Enter the ID of the Freshservice workspace where the service request is created.
  • Custom fields (JSON format) - Enter a JSON object with the custom fields to add to each new service request. These values are sent in the custom_fields object of the request. For example: {"labels": ["Axonius"]}.
  • Custom Field Description Key - Enter the custom field key that holds the description in the custom_fields JSON payload.
  • Custom Field Description Message - Enter the description message to place in the custom field set in Custom Field Description Key. You can replace the message with a Dynamic Value.
💡

Connection and Credentials

When Use stored credentials from the adapter is toggled off, some of the connection fields below are required to create the connection, while other fields are optional.

  • Freshservice Domain - The hostname of the Freshservice server.
  • API Key - Enter the API key provided by Freshservice.
  • Verify SSL (Optional) (default: enabled) - Selects whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings. This setting is enabled by default on all new adapter settings. If you need to disable SSL verification, make sure you disable this setting.)

  • HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

  • Throttle API Requests - Select this option to use only 90% of the API rate limit. For example, if 3000 API calls are allowed per hour, Axonius makes up to 2700 calls and leaves the remaining 10% available.
  • Gateway Name - Select the Gateway through which to connect to perform the action.

APIs

Axonius uses the Freshservice Service Catalog API - POST /api/v2/service_catalog/items/{display_id}/place_request.

Required Ports

Axonius must be able to communicate via the following ports:

  • TCP port 443

Required Permissions

The stored credentials, or those provided in Connection and Credentials, must have the following permission(s) to perform this Enforcement Action:

The action uses a Freshservice API key with Basic authentication. The API key must belong to a user that can place service requests for service catalog items. Confirm the required role with your Freshservice administrator.


For more details about other enforcement actions available, see Action Library.


Did this page help you?