Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific Company 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 associated with a company, such as for monitoring, auditing, or integration purposes.

Properties

Name Meaning
Webhook ID The unique identifier of the company 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. Specifies which 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 Determines whether user-defined fields (UDFs) should be brought up to the top level of the returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the company webhook.
  • name - The name of the company webhook.
  • url - The URL endpoint configured for the webhook.
  • eventTypes - The types of events that trigger the webhook.
  • isActive - Indicates whether the webhook is currently active.
  • createdDate - The date and time when the webhook was created.
  • modifiedDate - The date and time when the webhook was last modified.
  • userDefinedFields - An array of user-defined fields associated with the webhook, unless flattened to top-level properties.
    _label - Human-readable labels for picklist or reference fields, added if enabled in the input properties.

Dependencies

  • Requires an API key credential for authenticating with the Autotask REST API.

Troubleshooting

  • If the Webhook ID is invalid or does not exist, the node will throw an error indicating the webhook was not found. Verify the ID is correct.
  • If API authentication fails, ensure the API key credential is correctly configured and has sufficient permissions.
  • Selecting specific columns that do not exist may result in incomplete data or errors; verify field names or IDs are valid for the company webhook resource.
  • Enabling flattening of user-defined fields may cause naming conflicts if UDF names overlap with standard fields; use with caution.

Discussion