<EntityName>WebhookUdfField (SOAP API)
This article describes the WebhookUdfField entity for the Autotask SOAP API. For the REST API equivalent of this webhook, refer to <EntityName>WebhookUdfFields (REST API).
Overview
This entity names a user-defined field (UDF) that, when updated, will either trigger a webhook call or is always included with the payload of the webhook. At least one callout field (WebhookField or WebhookUdfField) is required to make a create() or update() call.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
Entity Name: | <EntityName>WebhookUdfField |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Each entity has a maximum number of active user-defined fields that you can define. For more information, refer to Managing user-defined fields.
IMPORTANT You can only query by one user-defined field at a time.
To learn how to make PUT, PATCH, and POST requests to entities that support UDFs, refer to Creating resources via POST request in the REST API, Updating data via PUT request with the REST API and Updating data via PATCH request with the REST API.
Fields
Field Name Label and Description |
Datatype | Read Only | Is Required | Reference Name | Picklist? |
---|---|---|---|---|---|
id <EntityName> Webhook UDF Field ID
This field contains the webhook identifier for a UDF that triggers a callout or is part of the payload. NOTE Use a query call to get the Field ID value to use. |
long | ||||
IsDisplayAlwaysField Is Display Always Field
The value of this field is true if the API adds the field to the payload when another field triggers a callout. NOTE Include external IDs as Display Always fields to facilitate cross-referencing with the client application. |
boolean | ||||
IsSubscribedField Is Subscribed Field
The value of this field is true if a change to the field triggers a callout. |
boolean | ||||
UdfFieldID UDF Field ID
This value is the internal Autotask ID for the user-defined field. |
integer | ||||
WebhookID <EntityName> Webhook ID
This value represents the internal ID assigned to a webhook. It is always prefaced with the name of the entity. EXAMPLE Account Webhook ID |
integer | <EntityName>Webhook (SOAP API) |