<EntityName>WebhookField (SOAP API)
This article describes the WebhookField entity of the Autotask SOAP API. For the REST API equivalent of this webhook, refer to <EntityName>WebhookFields (REST API).
Overview
This entity names a system field that when updated will either trigger a webhook call or is always part of the payload of the webhook. At least one callout field (WebhookField or WebhookUdfField) must be present to make a create() or update() call.
IMPORTANT The Autotask GUI uses field labels that can be changed by customer configurations and localization. To ensure consistency for integration programming, the AccountWebhookField and ContactWebhookField entities use REST API field names instead of SOAP API labels. Refer to theSOAP to REST webhook field mapping section of this article to learn how to interpret these names.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
| Entity Name: | <EntityName>WebhookField |
| Can Create: |
|
| Can Update: |
|
| Can Query: |
|
| Can Delete: |
|
| Can Have UDFs: |
Fields
|
Field Name Label and Description |
Datatype | Read Only | Is Required | Reference Name | Picklist? |
|---|---|---|---|---|---|
|
FieldID  Field ID
This value represents the internal Autotask ID for the system field. |
integer |
|
|
|
|
|
id <EntityName> Webhook Field ID
id represents the webhook identifier for a field that triggers a callout or is part of the payload. |
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 |
|
|||
|
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) |
SOAP to REST webhook field mapping
The SOAP AccountWebhookField and ContactWebhookField entities use REST API field names instead of SOAP API labels.
The following table maps webhook-supported SOAP to REST field and label names for the Account/Companies resources, the Contact/Contacts resources, the InstalledProduct/ConfigurationItems resources, the Ticket/Tickets resources, and the TicketNote/TicketNotes resources.
Account/Companies
SOAP entity name: Account
REST entity name: Companies
| Account field name | Account field label | Companies field name |
|---|---|---|
| AccountName | Client Name | companyName |
| AccountNumber | Client Number | companyNumber |
| AccountType | Client Type | companyType |
| Active | Account Active | isActive |
| AdditionalAddressInformation | Additional Address Information | additionalAddressInformation |
| Address1 | Address 1 | address1 |
| Address2 | Address 2 | address2 |
| AlternatePhone1 | Alternate Phone 1 | alternatePhone1 |
| AlternatePhone2 | Alternate Phone 2 | alternatePhone2 |
| ApiVendorID | API Vendor ID | apiVendorID |
| AssetValue | Asset Value | assetValue |
| City | City | city |
| ClientPortalActive | Client Portal Active | isClientPortalActive |
| CompetitorID | Competitor | competitorID |
| CountryID | Country ID | countryID |
| CurrencyID | Currency ID | currencyID |
| Fax | Fax | fax |
| KeyAccountIcon | Key Account Icon | classification |
| LastActivityDate | Last Activity Date | lastActivityDate |
| LastTrackedModifiedDateTime | Last Modified Date | lastTrackedModifiedDateTime |
| MarketSegmentID | Market Segment | marketSegmentID |
| OwnerResourceID | Client Owner | ownerResourceID |
| ParentAccountID | Parent Company | parentCompanyID |
| Phone | Phone | phone |
| PostalCode | Zip Code | postalCode |
| PurchaseOrderTemplateID | Purchase Order Template ID | purchaseOrderTemplateID |
| SICCode | SIC Code | sICCode |
| State | State | state |
| StockMarket | Stock Market | stockMarket |
| StockSymbol | Stock Symbol | stockSymbol |
| TaskFireActive | TaskFire Active | isTaskFireActive |
| TaxExempt | Tax Exempt | isTaxExempt |
| TaxID | Tax ID | taxID |
| TaxRegionID | Tax Region ID | taxRegionID |
| TerritoryID | Territory Name | territoryID |
| WebAddress | Web | webAddress |
Contact/Contacts
SOAP entity name: Contact
REST entity name: Contacts
| Contact field name | Contact field label | Contacts field name |
|---|---|---|
| AccountID | Client | companyID |
| AccountPhysicalLocationID | Account Physical Location | companyLocationID |
| Active | Active | isActive |
| AdditionalAddressInformation | Additional Address Information | additionalAddressInformation |
| AddressLine | Contact Address 1 | addressLine |
| AddressLine1 | Contact Address 2 | addressLine1 |
| AlternatePhone | Contact Alternate Phone | alternatePhone |
| BulkEmailOptOut | Bulk Email Opt Out | isOptedOutFromBulkEmail |
| City | Contact City | city |
| Country | Contact Country | countryID |
| CountryID | Contact Country ID | countryID |
| EMailAddress | emailAddress | |
| EMailAddress2 | Email2 | emailAddress2 |
| EMailAddress3 | Email3 | emailAddress3 |
| Extension | Contact Phone Ext. | extension |
| ExternalID | External ID | externalID |
| FacebookUrl | Facebook URL | facebookUrl |
| FaxNumber | Contact Fax | faxNumber |
| FirstName | First Name | firstName |
| LastActivityDate | Last Activity Date | lastActivityDate |
| LastModifiedDate | Last Modified Date | lastModifiedDate |
| LastName | Last Name | lastName |
| LinkedInUrl | LinkedIn URL | linkedInUrl |
| MiddleInitial | Middle Initial | middleInitial |
| MobilePhone | Contact Mobile Phone | mobilePhone |
| NamePrefix | Name Prefix | namePrefix |
| NameSuffix | Name Suffix | nameSuffix |
| Note | Note | note |
| Notification | Notification | receivesEmailNotifications |
| Phone | Contact Phone | phone |
| PrimaryContact | Primary Contact | primaryContact |
| RoomNumber | Room Number | roomNumber |
| SolicitationOptOut | Solicitation Opt Out | solicitationOptOut |
| State | Contact State | state |
| SurveyOptOut | Survey Opt Out | surveyOptOut |
| Title | Title | title |
| TwitterUrl | Twitter URL | twitterUrl |
| ZipCode | Contact Zip Code | zipCode |
InstalledProduct/ConfigurationItems
SOAP entity name: InstalledProduct
REST entity name: ConfigurationItems
| InstalledProduct field name | InstalledProduct field label | ConfigurationItems field name |
|---|---|---|
| AccountID | {LT:Account} | companyID |
| AccountPhysicalLocationID | Account Physical Location ID | companylocationID |
| Active | Product Active |
isActive |
| ApiVendorID | API Vendor ID | apiVendorID |
| ContactID | Contact Name | contactID |
| ContractID | Contract ID | contractID |
| ContractServiceBundleID | Contract Service Bundle ID | contractServiceBundleID |
| ContractServiceID | Contract Service ID |
contractServiceID |
| CreateDate | Create Date |
createDate |
| CreatedByPersonID | Created By Person ID | createdByPersonID |
| DailyCost | {LT:InstalledProduct} Daily Cost | dailyCost |
| DattoAvailableKilobytes | Datto Available Kilobytes | dattoAvailableKilobytes |
| DattoDeviceMemoryMegabytes | Datto Device Memory Megabytes | dattoDeviceMemoryMegabytes |
| DattoDrivesErrors | Datto Drives Errors | dattoDrivesErrors |
| DattoHostname | Datto Hostname | dattoHostname |
| DattoInternalIP | Datto Internal IP | dattoInternalIP |
| DattoKernelVersionID | Datto Kernel Version ID | dattoKernelVersionID |
| DattoLastCheckInDateTime | Datto Last Check In Date Time | dattoLastCheckInDateTime |
| DattoNICSpeedKilobitsPerSecond | Datto NIC Speed Kilobits Per Second | dattoNICSpeedKilobitsPerSecond |
| DattoNumberOfAgents | Datto Number Of Agents | dattoNumberOfAgents |
| DattoNumberOfDrives | Datto Number Of Drives | dattoNumberOfDrives |
| DattoNumberOfVolumes | Datto Number Of Volumes | dattoNumberOfVolumes |
| DattoOffsiteUsedBytes | Datto Offsite Used Bytes | dattoOffsiteUsedBytes |
| DattoOSVersionID | Datto OS Version ID | dattoOSVersionID |
| DattoPercentageUsed | Datto Percentage Used | dattoPercentageUsed |
| DattoProtectedKilobytes | Datto Protected Kilobytes | dattoProtectedKilobytes |
| DattoRemoteIP | Datto Remote IP | dattoRemoteIP |
| DattoSerialNumber | Datto Serial Number | dattoSerialNumber |
| DattoUptimeSeconds | Datto Uptime Seconds | dattoUptimeSeconds |
| DattoUsedKilobytes | DattoUsedKilobytes | dattoUsedKilobytes |
| DattoZFSVersionID | Datto ZFS Version ID | dattoZFSVersionID |
| DeviceNetworkingID | Device Networking ID | deviceNetworkingID |
| HourlyCost | {LT:InstalledProduct} Hourly Cost | hourlyCost |
| id | {LT:InstalledProduct} ID | id |
| ImpersonatorCreatorResourceID | Impersonator Creator Resource ID | impersonatorCreatorResourceID |
| InstallDate | Install Date | installDate |
|
InstalledByContactID |
Installed By Contact ID |
installedByContactID |
|
InstalledByID |
Installed By |
installedByID |
|
InstalledProductCategoryID |
Asset Category ID |
configurationItemCategoryID |
|
LastActivityPersonID |
Last Activity Person ID |
lastActivityPersonID |
|
LastActivityPersonType |
Last Activity Person Type |
lastActivityPersonType |
|
LastModifiedTime |
Last Modified Time |
lastModifiedTime |
|
Location |
Location |
location |
|
MonthlyCost |
{LT:InstalledProduct} Monthly Cost |
monthlyCost |
|
Notes |
{LT:InstalledProduct} Notes |
notes |
|
NumberOfUsers |
{LT:InstalledProduct} Number of Users |
numberOfUsers |
|
ParentInstalledProductID |
Parent {LT:InstalledProduct} |
parentConfigurationItemID |
|
PerUseCost |
{LT:InstalledProduct} Per Use Cost |
perUseCost |
|
ProductID |
Product ID |
productID |
|
ReferenceNumber |
Reference Number |
referenceNumber |
|
ReferenceTitle |
Reference Title |
referenceTitle |
|
RMMDeviceAuditAntivirusStatusID |
RMM Device Audit Antivirus Status ID |
rMMDeviceAuditAntivirusStatusID |
|
RMMDeviceAuditArchitectureID |
RMM Device Audit Architecture ID |
rMMDeviceAuditArchitectureID |
|
RMMDeviceAuditBackupStatusID |
RMM Device Audit Backup Status ID |
rMMDeviceAuditBackupStatusID |
|
RMMDeviceAuditDescription |
RMM Device Audit Description |
rMMDeviceAuditDescription |
|
RMMDeviceAuditDeviceTypeID |
RMM Device Audit Device Type ID |
rMMDeviceAuditDeviceTypeID |
|
RMMDeviceAuditDisplayAdaptorID |
RMM Device Audit Display Adaptor ID |
rMMDeviceAuditDisplayAdaptorID |
|
RMMDeviceAuditDomainID |
RMM Device Audit Domain ID |
rMMDeviceAuditDomainID |
|
RMMDeviceAuditExternalIPAddress |
RMM Device Audit External IP Address |
rMMDeviceAuditExternalIPAddress |
|
RMMDeviceAuditHostname |
RMM Device Audit Hostname |
rMMDeviceAuditHostname |
|
RMMDeviceAuditIPAddress |
RMM Device Audit IP Address |
rMMDeviceAuditIPAddress |
|
RMMDeviceAuditLastUser |
RMM Device Audit Last User |
rMMDeviceAuditLastUser |
|
RMMDeviceAuditMacAddress |
RMM Device Audit Mac Address |
rMMDeviceAuditMacAddress |
|
RMMDeviceAuditManufacturerID |
RMM Device Audit Manufacturer ID |
rMMDeviceAuditManufacturerID |
|
RMMDeviceAuditMemoryBytes |
RMM Device Audit Memory Bytes |
rMMDeviceAuditMemoryBytes |
|
RMMDeviceAuditMissingPatchCount |
RMM Device Audit Missing Patch Count |
rMMDeviceAuditMissingPatchCount |
|
RMMDeviceAuditMobileNetworkOperatorID |
RMM Device Audit Mobile Network Operator ID |
rMMDeviceAuditMobileNetworkOperatorID |
|
RMMDeviceAuditMobileNumber |
RMM Device Audit Mobile Number |
rMMDeviceAuditMobileNumber |
|
RMMDeviceAuditModelID |
RMM Device Audit Model ID |
rMMDeviceAuditModelID |
|
RMMDeviceAuditMotherboardID |
RMM Device Audit Motherboard ID |
rMMDeviceAuditMotherboardID |
|
RMMDeviceAuditOperatingSystem |
RMM Device Audit Operating System |
rMMDeviceAuditOperatingSystem |
|
RMMDeviceAuditPatchStatusID |
RMM Device Audit Patch Status ID |
rMMDeviceAuditPatchStatusID |
|
RMMDeviceAuditProcessorID |
RMM Device Audit Processor ID |
rMMDeviceAuditProcessorID |
|
RMMDeviceAuditServicePackID |
RMM Device Audit Service Pack ID |
rMMDeviceAuditServicePackID |
|
RMMDeviceAuditSNMPContact |
RMM Device Audit SNMP Contact |
rMMDeviceAuditSNMPContact |
|
RMMDeviceAuditSNMPLocation |
RMM Device Audit SNMP Location |
rMMDeviceAuditSNMPLocation |
|
RMMDeviceAuditSNMPName |
RMM Device Audit SNMP Name |
rMMDeviceAuditSNMPName |
|
RMMDeviceAuditSoftwareStatusID |
RMM Device Audit Software Status ID |
rMMDeviceAuditSoftwareStatusID |
|
RMMDeviceAuditStorageBytes |
RMM Device Audit Storage Bytes |
rMMDeviceAuditStorageBytes |
|
RMMDeviceID |
RMM Device ID |
rMMDeviceID |
|
RMMDeviceUID |
RMM Device UID |
rMMDeviceUID |
|
RMMOpenAlertCount |
RMM Open Alert Count |
rMMOpenAlertCount |
|
SerialNumber |
Serial Number |
serialNumber |
|
ServiceBundleID |
Service Bundle ID |
serviceBundleID |
|
ServiceID |
Service ID |
serviceID |
|
ServiceLevelAgreementID |
Service Level Agreement |
serviceLevelAgreementID |
|
SetupFee |
{LT:InstalledProduct} Setup Fee |
setupFee |
|
SourceCostType |
Source Cost Type |
sourceChargeType |
|
SourceCostID |
Source Cost ID |
sourceChargeID |
|
Type |
{LT:InstalledProduct} Type |
configurationItemType |
|
VendorID |
Vendor Name |
vendorID |
|
WarrantyExpirationDate |
Warranty Expiration Date |
warrantyExpirationDate |
Ticket/Tickets
NOTE Webhooks are only supported by the Tickets REST entity.
SOAP entity name: Ticket
REST entity name: Tickets
| Ticket field name | Ticket field label | Tickets field name |
|---|---|---|
| AccountID | {LT:Account} |
companyID |
| AccountPhysicalLocationID | Account Physical Location ID |
companyLocationID |
| AssignedResourceID | Resource |
assignedResourceID |
| AssignedResourceRoleID | Resource Role Name |
assignedResourceRoleID |
| ChangeApprovalBoard | Change Approval Board ID |
changeApprovalBoard |
| ChangeApprovalStatus | Change Approval Status |
changeApprovalStatus |
| ChangeApprovalType | Change Approval Type |
changeApprovalType |
| ChangeInfoField1 | Change Info Field 1 |
changeInfoField1 |
| ChangeInfoField2 | Change Info Field 2 |
changeInfoField2 |
| ChangeInfoField3 | Change Info Field 3 |
changeInfoField3 |
| ChangeInfoField4 | Change Info Field 4 |
changeInfoField4 |
| ChangeInfoField5 | Change Info Field 5 |
changeInfoField5 |
| CompletedByResourceID | Ticket Completed By |
completedByResourceID |
| CompletedDate | Ticket Date Completed by Complete Project Wizard |
completedDate |
| ContactID | Ticket Contact |
contactID |
| ContractID | Contract |
contractID |
| ContractServiceBundleID | Contract Service Bundle ID |
contractServiceBundleID |
| ContractServiceID | Contract Service ID |
contractServiceID |
| CreatedByContactID | Created By Contact |
createdByContactID |
| CreatorResourceID | Created By Resource |
createdByResourceID |
| Description | Ticket Description |
description |
| DueDateTime | Ticket End Date |
dueDateTime |
| EstimatedHours | Ticket Estimated Hours |
estimatedHours |
| ExternalID | Ticket External ID |
externalID |
| FirstResponseDateTime | First Response Date Time |
firstResponseDateTime |
| FirstResponseDueDateTime | First Response Due Date Time |
firstResponseDueDateTime |
| HoursToBeScheduled | Hours To Be Scheduled |
hoursToBeScheduled |
| ImpersonatorCreatorResourceID | Impersonator Creator Resource |
impersonatorCreatorResourceID |
| InstalledProductID | {LT:InstalledProduct} |
configurationItemID |
| IssueType | Ticket Issue |
issueType |
| LastActivityDate | Ticket Last Activity Date |
lastActivityDate |
| LastCustomerNotificationDateTime | Last Customer Notification DateTime |
LastCustomerNotificationDateTime |
| LastCustomerVisibleActivityDateTime | Last Customer Visible Activity Time |
lastCustomerVisibleActivityDateTime |
| LastTrackedModificationDateTime | Last Tracked Modification Date Time |
lastTrackedModificationDateTime |
| MonitorID (Datto RMM integration only) |
Monitor ID |
monitorID |
| MonitorTypeID (Datto RMM integration only) |
Monitor Type ID |
monitorTypeID |
| OpportunityId | Opportunity ID |
opportunityID |
| Priority | Ticket Priority |
priority |
| ProblemTicketId | Problem Ticket ID |
problemTicketID |
| ProjectID | Project ID |
projectID |
| PurchaseOrderNumber | Purchase Order Number |
purchaseOrderNumber |
| QueueID | Ticket Department Name OR Ticket Queue Name |
queueID |
| Resolution | Resolution |
resolution |
| ResolutionPlanDateTime | Resolution Plan Date Time |
resolutionPlanDateTime |
| ResolutionPlanDueDateTime | Resolution Plan Due Date Time |
resolutionPlanDueDateTime |
| ResolvedDateTime | Resolved Date Time |
resolvedDateTime |
| ResolvedDueDateTime | Resolved Due Date Time |
resolvedDueDateTime |
| RMAStatus | RMA Status |
rmaStatus |
|
RMAType |
RMA Type |
rmaType |
| RMMAlertID (Datto RMM integration only) |
RMM Alert ID |
rMMAlertID |
| SecondaryResources | Secondary Resources(current value) |
secondaryResources |
| ServiceLevelAgreementHasBeenMet | Has Met SLA |
serviceLevelAgreementHasBeenMet |
| ServiceLevelAgreementID | Service Level Agreement ID |
serviceLevelAgreementID |
| Source | Ticket Source |
source |
| Status | Ticket Status |
status |
| SubIssueType | Ticket Subissue Type |
subIssueType |
| TicketAdditionalContact | Ticket Additional Contact(current value) |
ticketAdditionalContact |
| TicketCategory | Ticket Category |
ticketCategory |
| TicketCreateDate | Ticket Create Date |
ticketCreateDate |
| TicketNumber | Ticket Number |
ticketNumber |
| TicketType | Ticket Type |
ticketType |
| Title | Ticket Title |
title |
TicketNote/TicketNotes
NOTE Webhooks are only supported by the TicketNotes REST entity.
SOAP entity name: TicketNote
REST entity name: Tickets
| Ticket field name | Ticket field label | Tickets field name |
|---|---|---|
| CreateDateTime | Create Date Time |
createDateTime |
|
CreatedByContactID |
Created by Contact ID |
createdByContactID |
| CreatorResourceID | Creator Resource |
creatorResourceID |
| Description | Description |
description |
| id | Ticket Note ID |
id |
| ImpersonatorCreatorResourceID | Impersonator Creator Resource ID |
impersonatorCreatorResourceID |
| ImpersonatorUpdaterResourceID | Impersonator Updater Resource ID |
impersonatorUpdaterResourceID |
| LastActivityDate | LastActivityDate |
lastActivityDate |
| NoteType | Note Type |
noteType |
| Publish | Publish |
publish |
| TicketID | Ticket |
ticketID |
| Title | Title |
title |
Sample request
Here is a sample SOAP request that will trigger a callout when field ID 13 (the Zip Code field) is changed.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AutotaskIntegrations xmlns="http://autotask.net/ATWS/v1_6/">
<IntegrationCode>INSERTYOUROWN</IntegrationCode>
</AutotaskIntegrations>
</soap:Header>
<soap:Body>
<create xmlns="http://autotask.net/ATWS/v1_6/">
<Entities>
<Entity xsi:type="AccountWebhookField" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<FieldID>13</FieldID>
<IsDisplayAlwaysField>True</IsDisplayAlwaysField>
<IsSubscribedField>True</IsSubscribedField>
<WebhookID>1</WebhookID>
</Entity>
</Entities>
</create>
</soap:Body>
</soap:Envelope>
You must add a separate callout for each field where a change will trigger a callout, or for each field that you want to add to the payload when another field triggers a callout.
