<EntityName>WebhookExcludedResources (REST)
This article describes the WebhookExcludedResources entity for the Autotask REST API. For the SOAP API equivalent of this webhook, refer to <EntityName>WebhookExcludedResource (SOAP).
Overview
This entity names the resources, for each webhook, whose modifications will not generate an outbound call even if a triggering event occurs.
BEFORE YOU BEGIN Examples in this article may use the webservices[n].autotask.net placeholder. In such instances, substitute [n] for the zone of your user, as described in Autotask API zones and WSDL versions > Find your zone's API URL for the REST API or Autotask API zones and WSDL versions > Find your zone's WSDL file URL for SOAP API version 1.6.
Entity details
You can also retrieve this information with the GET and POST REST API calls.
| Entity Name: | <EntityName>WebhookExcludedResources |
| 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  <EntityName> Webhook Excluded Resources ID
This field records the unique identifier for the combination of resource and webhook that will not trigger the callout.
|
long |
|
|
|
|
ResourceID Resource ID
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 <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) |
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 REST request that will exclude the Resource with the named ID from triggering the webhook.
POST https://webservices[n].autotask.net/atservicesrest/v1.0/ContactWebhooks/9/ExcludedResources
{
"ResourceID":29682900,
"WebhookID":9
}
