Configure Alert Using SOAP Method
Webhook is a mechanism that informs users, other applications, or IT systems when something happens in processes. After data upload, the application sends a corresponding notification if some timelines meet the set conditions.
You can create a webhook using the SOAP method, that will send information to a Web Service each time the alert is triggered in the program.
Before you begin
Timeline requires a predefined WSDL document that describes a Web Service. It includes available actions, used protocols, where information is sent, etc. Please contact the SOAP service support team to get a valid URL with a WSDL document.
- Timeline sends a request with static operation inputs that you specify while configuring a webhook. A Web Service does not receive other information such as matched timeline IDs, event attributes, or other data from the program.
- Timeline supports only WSDL 1.1.
- The Web Service should use the SOAP protocol for message exchange.
How to create Webhook
- Click to open the Edit alert window.
Important. You should add an alert and configure its settings before creating a webhook. For instructions, see How to Create and Execute Alert.
- Click in the Webhooks section.
- Select the SOAP method.
- Enter URL WSDL.
Specify a valid URL for the location, where the WSDL document is hosted. WSDL is the XML definition of a Web Service. URL WSDL hosted the document that allows to read the Web Service structure. For example:
- Click Get WSDL.
Timeline will parse a WSDL document and get available services, ports, and operations on the Web Service.
- Choose HTTP Basic Auth in case the target Web Service needs authentication. Enter User name and Password in the corresponding fields.
- Enter Webhook name. It will help identify it in the list of created webhooks in the Edit alert window.
- Configure parameters and inputs for the XML file that the program sends to the Web Service.
|Parameter||Description and configuration|
A set of functions available for the Web-based protocols.
Select Service, that provides needed Port and Operation.
A connection point to the Web Service.
Select Port, that uses the SOAP protocol.
A list of available actions on the Web Service, defined in the WSDL document. You need to enter operation inputs that Timeline sends to the Web Service. To do this:
- Click Test to check that the webhook is configured correctly.
Timeline will send a request to the SOAP endpoint. If performed successfully on the Timeline side, the program shows Status: 200 in the pop-up message.
- Click Save.
After the next alert execution, Timeline will send a request with specified operation inputs to the Web Service.
Timeline can notify a Web Service about occurring alerts. That allows to take immediate actions if necessary. Further, you can proceed with data analysis in Timeline.
For example, your system must perform steps in the process at a certain period of time. You can warn the Web Service about violations in the system using Timeline alerts. To do this, configure the alert based on a Deadline that informs a Web Service if it takes too long to perform the required steps.
5/25/2023 10:12:06 AM