<EntityName>Webhooks (REST API)

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

Overview

This entity describes the fields that populate to generate a webhook for an entity.

You can subscribe a callout to one of the callout types (PATCH, PUT 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.

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 versionsFind your zone's API URL for the REST API or Autotask API zones and WSDL versionsFind your zone's WSDL file URL for SOAP API version 1.6.

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 GET and POST REST API calls.

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?

Deactivationurl

string (500)      

id

long    

IsActive

boolean      

IsReady

boolean      

IsSubscribedToCreateEvents

boolean        

IsSubscribedToDeleteEvents

boolean        

IsSubscribedToUpdateEvents

boolean        

Name

string (50)      

NotificationEmailAddress

string (150)        

OwnerResourceID

integer   Resource  

SecretKey

string (64)      

SendThresholdExceededNotification

boolean      

WebhookGUID

string (100)      

WebhookUrl

string (500)      

Sample request

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

POST https://webservices[n].autotask.net/atservicesrest/v1.0/CompanyWebhooks

{
"IsActive": true,
"DeactivationUrl": "https://wrkhbq676nwh8.d.samplecompany.net",
"IsSubscribedToUpdateEvents": true,
"Name": "myintegration.Accounts.Modify",
"SecretKey": "12345678",
"SendThresholdExceededNotification": false,
"WebhookUrl": "https://wrkhbq676nwh8.d.samplecompany.net"
}