<EntityName>WebhookExcludedResource (SOAP)

This article describes the WebhookExcludedResource entity for the Autotask SOAP API. For the REST API equivalent of this webhook, refer to <EntityName>WebhookExcludedResources (REST).

Overview

This entity names the resources, for each webhook, whose modifications will not generate an outbound call even if a triggering event occurs.

Entity details

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

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

Fields

Field Name

Label and Description

 Datatype Read Only Is Required Reference Name

id

This field records the unique identifier for the combination of resource and webhook that will not trigger the callout.
 long  

ResourceID

This field contains the Autotask Resource ID of the resource whose actions will not trigger the callout even if all other conditions are met. Refer to 5. Excluding specific resources from triggering webhooks (optional) for more information.

 integer   Resource

WebhookID

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)

NOTE  Creating WebhookExcludedResources for an entity will only exclude that resource from triggering the callout associated with the WebhookID supplied. The resource will still trigger other webhooks unless you establish exclusions for them as well.

Sample request

Here is a sample SOAP request that will exclude the Resource with the named ID from triggering the webhook.

            <?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="AccountWebhookExcludedResource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <ResourceID>30686448</ResourceID>
          <WebhookID>1</WebhookID>
        </Entity>
      </Entities>
    </create>
  </soap:Body>
</soap:Envelope>