Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Configuration Item Webhook records from the Autotask REST API using advanced filtering criteria. It is useful for users who need to query and extract specific webhook configurations based on complex conditions, such as filtering by multiple fields or applying custom query logic. For example, a user can fetch all configuration item webhooks that match certain status or event types, with control over the number of records returned and the fields included in the response.

Properties

Name Meaning
Get All Determines whether to return all matching Configuration Item Webhook records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of Configuration Item Webhook records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A JSON string containing a 'filter' array that defines the Autotask API query criteria for filtering Configuration Item Webhook records. This allows complex and precise queries based on field values.
Add Picklist Labels If enabled, adds additional '_label' fields to the output for picklist fields, providing human-readable values instead of raw codes.
Add Reference Labels If enabled, adds additional '_label' fields to the output for reference fields, providing human-readable values.
Select Columns Names or IDs. Allows selection of specific fields to include in the response. If no fields are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are moved to the top level of each returned object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the Configuration Item Webhook record.
  • fieldName - Various fields of the Configuration Item Webhook as returned by the Autotask API, including standard and user-defined fields.
  • _label - Additional fields with '_label' suffix provide human-readable labels for picklist and reference fields if enabled.
  • userDefinedFields - Array of user-defined fields associated with the Configuration Item Webhook, unless flattened to top-level properties.

Dependencies

  • Requires an Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • Invalid JSON in the 'Advanced Filter' property can cause query failures. Ensure the JSON string is well-formed and follows Autotask API filter syntax.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • Selecting invalid or non-existent field names in 'Select Columns' may result in incomplete or empty data fields.
  • If labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields support labels.
  • API authentication errors may occur if the Autotask API key credential is missing or invalid.

Links

Discussion