Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific Contact Webhook in the Autotask system by its unique Webhook ID. It is useful for scenarios where you need to fetch configuration or status details of a particular webhook that triggers on contact-related events. For example, you might use this to verify webhook settings, audit webhook configurations, or integrate webhook data into other workflows.

Properties

Name Meaning
Webhook ID The unique identifier of the contact webhook to retrieve. This is required to specify which webhook's details to fetch.
Add Picklist Labels Determines whether to automatically add human-readable '_label' fields for picklist fields in the response. Labels are only added for non-empty values.
Add Reference Labels Determines whether to automatically add human-readable '_label' fields for reference fields in the response. Labels are only added for non-empty 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 regardless of selection.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are brought to the top level of each object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contact webhook.
  • name - The name of the contact webhook.
  • url - The URL endpoint that the webhook calls.
  • events - List of events that trigger the webhook.
  • picklist_field_label - Human-readable labels for picklist fields if 'Add Picklist Labels' is enabled.
  • reference_field_label - Human-readable labels for reference fields if 'Add Reference Labels' is enabled.
    userDefinedFields - User-defined fields nested inside userDefinedFields array or flattened to top-level if 'Flatten User-Defined Fields' is enabled.

Dependencies

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

Troubleshooting

  • If the Webhook ID is invalid or not found, the node will throw an error indicating the webhook does not exist. Verify the ID is correct.
  • If API authentication fails, ensure the Autotask API key credential is correctly configured and has sufficient permissions.
  • Selecting fields that do not exist may result in incomplete data or errors; verify field names or IDs when using 'Select Columns'.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may increase response size; disable if not needed to optimize performance.

Links

Discussion