Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

This node operation retrieves multiple Company Webhook records from the Autotask REST API using advanced filtering criteria. It is useful for users who need to query and extract specific webhook data based on complex conditions, such as filtering by status, creation date, or other webhook attributes. For example, a user can fetch all active company webhooks created after a certain date or matching specific custom fields.

Properties

Name Meaning
Get All Determines whether to return all matching webhook records or limit the number of results.
Max Records Specifies the maximum number of 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 with Autotask API query criteria to filter the 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 for reference fields to show 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 object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the company webhook record.
  • fieldName - Various fields of the company webhook as returned by the Autotask API, including standard and user-defined fields.
  • fieldName_label - Human-readable labels for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields if 'Flatten User-Defined Fields' is disabled; otherwise, UDFs appear as top-level properties.

Dependencies

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

Troubleshooting

  • Invalid JSON in '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.
  • If no records are returned, verify that the filter criteria match existing company webhooks.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may increase response size; disable if not needed.
  • Incorrect field names in 'Select Columns' or filter criteria can cause errors; use 'Get Field Info' to confirm exact field names.

Links

Discussion