Call webhook action

With the Call webhook action, you define that an HTTP request is sent to a predefined URL as the result of the triggering event. CAS genesisWorld supports POST requests via HTTP(S) with a body in JSON format.

URL

Here, you enter the endpoint URL of the third-party system you wish to call. We recommend you use HTTPS for security reasons.

JSON

The JSON code has to meet the following conditions:

• The JSON code has to comply with the standards for RFC 8259 and ECMA-404.
• The third-party requirements for the JSON structure have to be met.

You can enter placeholders for field values from the Action field and Table field tabs in the JSON input field. When executing rules, the placeholders are replaced by the respective field values.

Please note the following characteristics:

• Fields of the datetime data type are formatted according to ISO 8601, for example, 2012-04-23T18:25:43.511Z.
• Fields of the bit data type are displayed as true or false.
• Fields of the money data type are not differentiated from float point numbers, for example, 55.5.
• Fields with null values remain empty.
• The values from action fields with a link are formatted as pure hyperlinks. The final format of the hyperlink should be adapted to suit the structure of the respective third-party system. This applies to the following action fields:
  • Link to CAS genesisWorld Web
  • Link to CAS genesisWorld SmartDesign App
  • Link to teamWorks.

In the Preview, the placeholders are replaced by test values.

With the Align text button, you can format the JSON source code to be compact and well-structured.

When clicking the Test button beneath the input field, the JSON syntax is checked. If the syntax is correct, then the content of the JSON field is sent to the URL which has been entered in the system together with the test values. The test results are displayed in the Status field. The following status are available:

• -1: Syntax error in JSON.
• HTTP status code between 200 and 299: the test was successful.
• Other HTTP status codes: the test was unsuccessful.

Restrictions

Please note that the successful delivery of data to a third-party system using webhooks cannot be guaranteed for a number of reasons:

• The fact that a rule can also be saved, even if the testing of the respective webhook proved to be unsuccessful.
• The availability of the endpoint URL and the expected format of the JSON code can be changed in the third-party system.
• The internet access was missing.