Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves a specific Configuration Item Webhook from the Autotask system by its unique Webhook ID. It is useful for scenarios where you need to fetch detailed information about a particular webhook configuration, such as for monitoring, auditing, or integration purposes. For example, you might use this node to get the settings of a webhook that triggers on configuration item changes to ensure it is correctly set up or to use its data in further automation workflows.

Properties

Name Meaning
Webhook ID The unique identifier of the Configuration Item Webhook to retrieve. This is required to specify which webhook to get.
Add Picklist Labels Whether to automatically add human-readable '_label' fields for picklist fields in the response, enhancing readability by including label values alongside raw data.
Add Reference Labels Whether to automatically add human-readable '_label' fields for reference fields in the response, providing more understandable values for referenced entities.
Select Columns Names or IDs. Specifies which fields to include in the response. If none are selected, all fields are returned. The ID field is always included regardless of selection.
Flatten User-Defined Fields Whether to bring user-defined fields (UDFs) up to the top level of the returned object instead of nested inside a userDefinedFields array, simplifying access to these custom fields.

Output

JSON

  • id - The unique identifier of the Configuration Item Webhook.
  • name - The name of the webhook.
  • url - The URL endpoint that the webhook calls.
  • eventType - The event type that triggers the webhook.
  • active - Indicates if the webhook is active.
  • picklistField_label - Human-readable labels for picklist fields if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable labels for reference fields if 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields unless 'Flatten User-Defined Fields' is enabled, in which case these fields appear at the top level.

Dependencies

  • Requires an API key credential for Autotask REST API authentication.

Troubleshooting

  • Ensure the provided Webhook ID is correct and exists in the Autotask system; otherwise, the node will fail to retrieve data.
  • If the node returns incomplete data, verify the 'Select Columns' property to include all necessary fields.
  • If labels for picklist or reference fields are missing, check that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields have non-empty values.
  • Authentication errors indicate issues with the Autotask API credentials; verify that the API key is valid and has sufficient permissions.

Discussion