<EntityName>Webhook (SOAP API)

This entity describes the fields that populate to generate a webhook for an entity in the Autotask SOAP API. For the REST API equivalent of this webhook, refer to <EntityName>Webhooks (REST API).

Overview

You can subscribe a callout to one of the callout types (Create, Update or Delete), or up to all three of them. When a callout subscribes to multiple types, they will share a single Webhook URL and Webhook ID.

Supported entities

The following Autotask entities currently support webhooks:

  • Companies (Accounts)
  • Contacts
  • Assets (Configuration Items)
  • Tickets, including tickets created in Taskfire (REST only)
  • Ticket Notes, including ticket notes created in Taskfire (REST only)

We will continuously add webhook support to additional entities.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: <EntityName>Webhook
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Fields

Field Name

Label and Description

Datatype Read Only Is Required Reference Name Is supported Webhook Field?

Active

boolean      

Deactivationurl

string (500)      

id

long    

IsSubscribedToCreateEvents

boolean        

IsSubscribedToDeleteEvents

boolean        

IsSubscribedToUpdateEvents

boolean        

Name

string (50)      

NotificationEmailAddress

string (150)        

OwnerResourceID

integer   Resource  

Ready

boolean      

SecretKey

string (64)      

SendThresholdExceededNotification

boolean      

WebhookGUID

string (100)      

WebhookUrl

string (500)      

Sample request

Here is a sample SOAP request for a webhook that would fire if an account was modified:

<?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="AccountWebhook" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <Active>True</Active>
          <DeactivationUrl>https://enkmoj676nwh8.x.pipedream.net</DeactivationUrl>
          <IsSubscribedToUpdateEvents>True</IsSubscribedToUpdateEvents>
          <Name>Angela.Accounts.Modify</Name>
          <SecretKey>20201</SecretKey>
          <WebhookUrl>https://enymf79yfhr0d.x.pipedream.net</WebhookUrl>
        </Entity>
      </Entities>
    </create>
  </soap:Body>