List of Enate's Webhooks
The following Webhooks are currently available in Enate:
PacketCreated - fires when a Ticket, Case or Action is created.
PacketUpdated - fires when a Ticket, Case or Action is updated.
NewCommunication - fires when a communication (email or note) is added to a specific work item
BusinessObjectCreated - fires when a COMPANY or a SCHEDULE is created.
BusinessObjectUpdated - fires when a COMPANY or a SCHEDULE is updated.
SpecificBusinessObjectUpdated - fires when a COMPANY or a SCHEDULE, specified within the subscription, is updated.
The sections below give details for the webhooks you can currently subscribe to, a short description of the events which will trigger them, the data you'll get returned from the webhook (with example values for each) and the parameters which are to be passed in.
Note that the term 'Packet' here refers to Enate's Work Items - which can be of type Case, Action or Ticket.
Packet Created
Name | Packet Created |
Related events | Creation of any work item i.e. Case, Action, Ticket |
Message returned | Returns basic packet information in JSON format: { "CustomerName": the name of the customer e.g. "Globex Corporation", "SupplierName": the name of the supplier e.g. "Initech", "ContractName": the name of the contract e.g. "Capital Discovery", "ServiceName": the name of the service e.g. "HR Relief", "ServiceLineName": the name of the service line e.g. "East Coast", "ProcessTypeName": the name of the process type e.g. "Start Employee", "Reference": this is a system generated identifier for a packet, it follows Enate’s own formatting e.g. "202234-C", "Title": the title of the packet. This is not set until the packet is submitted when it is set by the user (or whatever is creating the packet) – newly created packets won’t have it yet e.g. “Standard Appeal”, "Status": the status of the packet. Draft = 0, ToDo = 1, InProgress = 2, Waiting = 3, Resolved = 4, Closed = 5 "DueDate": this is not set until the packet is submitted – newly created packets won’t have it yet e.g. null "RAGStatus": the RAG status of the packet, e.g. 1. ToBeDetermined = -2, Overdue = -1, DueToday = 0, DueInFuture = 1 "ProcessType": the process type, e.g. 1. Case = 1, Ticket = 2, Action = 3 "GUID": the Webhook GUID e.g. "215d6b04-f587-eb11-b9ad-e86a64437383" } |
Parameters required | "Webhook": name of the WebHook being subscribed to i.e. PacketCreated "FilterObjectGUID": mandatory filter of identifying GUID for either · Company (customer) · Contract · Service or · Case/Ticket Process "FilterObjectType": ID for the type of object being filtered by i.e. · Company = 31 · Contract = 215 · Service = 217 · Process = 911 "SubscriberURL": a valid URL (inc. http/https") which can receive the WebHook message "CustomHeader": optional field which adds a custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process. i.e. New-packet-subscription "CustomHeaderValue": optional field which adds a corresponding value to the custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. New packet created for Globex Corporation" |
Restrictions | The user account creating the subscription must have permission to access data related to the requested entity (Customer, Contract etc.) |
Packet Updated
Name | PacketUpdated |
Related events | Updates to a specified work item |
Message returned | Returns basic packet information in JSON format: { "CustomerName": the name of the customer e.g. "Globex Corporation", "SupplierName": the name of the supplier e.g. "Initech", "ContractName": the name of the contract e.g. "Capital Discovery", "ServiceName": the name of the service e.g. "HR Relief", "ServiceLineName": the name of the service line e.g. "East Coast", "ProcessTypeName": the name of the process type e.g. "Start Employee", "Reference": this is a system generated identifier for a packet, it follows Enate’s own formatting e.g. "202234-C", "Title": the title of the packet. This is not set until the packet is submitted when it is set by the user (or whatever is creating the packet) – newly created packets won’t have it yet e.g. “Standard Appeal”, "Status": the status of the packet e.g. "0". Draft = 0, ToDo = 1, InProgress = 2, Waiting = 3, Resolved = 4, Closed = 5 "DueDate": this is not set until the packet is submitted – newly created packets won’t have it yet e.g. "null" "RAGStatus": the RAG status of the packet e.g. "-2". ToBeDetermined = -2, Overdue = -1, DueToday = 0, DueInFuture = 1 "ProcessType": the process type e.g. "1". Case = 1, Ticket = 2, Action = 3 "GUID": the Webhook GUID e.g. "215d6b04-f587-eb11-b9ad-e86a64437383" } |
Parameters required | "Webhook": Name of the WebHook being subscribed to i.e. PacketUpdated "FilterObjectGUID": Mandatory filter of identifying GUID for required packet "FilterObjectType": "ID for the type of object being filtered by i.e. · Packet = 81 "SubscriberURL": "A valid URL (inc. http/https") which can receive the WebHook message "CustomHeader": optional field which adds a custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process. i.e. Update-packet-subscription "CustomHeaderValue": optional field which adds a corresponding value to the custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. Packet 200243-C updated" |
Restrictions | The user account creating the subscription must have permission to access data related to the requested packet |
Note: For Packet Updated you need to supply a packet GUID, so you would use:
FilterObjectType = 81 (Packet in the EnateObjects enum)
FilterObjectGUID = <any valid PacketGUID you can access>
WebHook = PacketUpdated
NewCommunication
Name | NewCommunication |
Related events | New communications added to a specified work item |
Message returned | Returns basic communication information in JSON format: { "To": "to" email address "Importance": 0 = normal, 1 = low, 2 = high "CC": mail address included in CC "From": "from" email address if included in the email/message formats "Subject": pulled from the subject field of the communication, if it has one, e.g. "TPS Reports", "AttachmentCount": this is the number of attachments on the communication e.g. 30, "GUID": the Webhook GUID e.g. "31fbfa65-dc39-4c9c-a1f4-47dfef636bea", "PacketGUID": this identifies the Packet which is being reported on, the GUID in the response when creating a new subscription is the identifier for hat subscription e.g. "878409be-7886-eb11-b9ad-e86a64437383", "CommunicationType": the communication type used, e.g. 7. EmailOutgoing = 0, PhoneIncoming = 1, EmailIncoming = 2, ESSComment = 3, AuditNote = 4, PhoneOutgoing = 5, LetterIncoming = 6, LetterOutgoing = 7 } |
Parameters required | "Webhook": Name of the WebHook being subscribed to i.e. NewCommunication "FilterObjectGUID": Mandatory filter of identifying GUID for required packet "FilterObjectType": "ID for the type of object being filtered by i.e. · Packet = 81 "SubscriberURL": "A valid URL (inc. http/https") which can receive the WebHook message "CustomHeader": optional field which adds a custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. new-communication "CustomHeaderValue":optional field which adds a corresponding value to the custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. New communication added to 200243-C" |
Restrictions | The user account creating the subscription must have permission to access data related to the requested packet |
For NewCommunication you need to supply a packet GUID, so you would use:
FilterObjectType = 81 (Packet in the EnateObjects enum)
FilterObjectGUID = <any valid PacketGUID you can access>
WebHook = NewCommunication
A NewCommunication webhook subscription will result in a message being sent whenever a new communication of any sort (a Note, Incoming Email, Outgoing Email etc.) is added to the specified packet.
BusinessObjectCreated
Name | BusinessObjectCreated |
Related events | A new business object of a specified type is created (Object types Company and Schedule are provided in this release) |
Message returned | Returns basic object information in JSON format: { "Name": name is set by the user, e.g. "2022 Schedule", "GUID": the Webhook GUID e.g. "a3bc0b28-8023-4ac2-a0c4-2144e8a2d659" } |
Parameters required | "Webhook": Name of the WebHook being subscribed to i.e. NewBusinessObject "FilterObjectGUID": Mandatory filter of identifying GUID for required packet "FilterObjectType": "ID for the type of object being filtered by i.e. · Schedule = 260 or · Company = 31 "SubscriberURL": "A valid URL (inc. http/https") which can receive the WebHook message "CustomHeader": optional field which adds a custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. new-schedule "CustomHeaderValue": optional field which adds a corresponding value to the custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. New schedule created" |
Restrictions | User must have Process Builder role |
For Business Object Created you only need to supply the FilterObjectType, so you would use:
FilterObjectType = 31 (Company in the EnateObjects enum)
WebHook = BusinessObjectCreated
OR
FilterObjectType = 81 (Schedule in the EnateObjects enum)
WebHook = BusinessObjectCreated
BusinessObjectUpdated
Name | BusinessObjectUpdated |
Related events | Any existing business object of a specified type is updated (Object types Company and Schedule are provided in this release) |
Message returned | Returns basic object information in JSON format: { "Name": name is set by the user, e.g. "2022 Schedule", "GUID": the Webhook GUID e.g. "a3bc0b28-8023-4ac2-a0c4-2144e8a2d659" } |
Parameters required | "Webhook": Name of the WebHook being subscribed to i.e. BusinessObjectUpdated "FilterObjectGUID": Should be left empty "FilterObjectType": "The type of object being filtered by i.e.
"SubscriberURL": "A valid URL (inc. http/https") which can receive the WebHook message "CustomHeader": optional field which adds a custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. updated-company "CustomHeaderValue": optional field which adds a corresponding value to the custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. Company details have been updated |
Restrictions | User must have Process Builder role |
SpecificBusinessObjectUpdated
Name | SpecificBusinessObjectUpdated |
Related events | A specific business object of a specified type is updated (Object types Company and Schedule are provided in this release) |
Message returned | Returns basic object information in JSON format: { "Name": name is set by the user, e.g. "2022 Schedule", "GUID": the Webhook GUID e.g. "a3bc0b28-8023-4ac2-a0c4-2144e8a2d659" } |
Parameters required | "Webhook": Name of the WebHook being subscribed to i.e. BusinessObjectUpdated "FilterObjectGUID": Filter of identifying GUID for required business object "FilterObjectType": "The type of object being filtered by i.e.
"SubscriberURL": "A valid URL (inc. http/https") which can receive the WebHook message "CustomHeader": optional field which adds a custom header to all messages sent by the Webhook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. updated-company "CustomHeaderValue": optional field which adds a corresponding value to the custom header to all messages sent by the WebHook subscription – it can be used, for example, to include additional authentication information to ensure incoming messages are genuine, or to enrich incoming messages to make them easier to identify and process i.e. Company details have been updated |
Restrictions | User must have Process Builder role |
Last updated