Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

The 'Contact Webhook - Get Many (Advanced)' operation in the Autotask node allows users to retrieve multiple contact webhook records from the Autotask REST API using advanced filtering criteria. This operation is beneficial when you need to query contact webhook data with complex conditions beyond simple filters, such as combining multiple criteria in a JSON-based filter. For example, you can fetch all contact webhooks created after a certain date or those matching specific status codes. It supports returning all matching records or limiting the number of results, and can enhance the output by adding human-readable labels for picklist and reference fields, as well as flattening user-defined fields for easier access.

Properties

Name Meaning
Get All Determines whether to return all matching contact webhook records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contact webhook records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array that defines the Autotask API query criteria for filtering contact webhook records. This allows complex queries using Autotask's REST API filtering syntax.
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, simplifying access.

Output

JSON

  • id - Unique identifier of the contact webhook record.
  • fieldName - Various fields of the contact webhook record 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 contact webhook, unless flattened to top-level properties.

Dependencies

  • Requires an Autotask API credential with appropriate permissions to access contact webhook data.
  • Relies on the Autotask REST API endpoint for contact webhooks.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and follows Autotask API filter syntax.
  • Requesting too many records without proper limits may lead to timeouts or API rate limiting. Use 'Get All' judiciously or set reasonable 'Max Records'.
  • If picklist or reference labels are not appearing, verify that the corresponding fields have valid values and that label addition options are enabled.
  • Errors related to authentication indicate issues with the provided Autotask API credentials; verify and update credentials as needed.

Links

Discussion