...
As of Version | 2021 Autumn | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | ||||||||||||||||||
Response Format | JSON | ||||||||||||||||||
Description |
The webhook receives the completed objects just before they are indexed. This means that the objects are already enriched with system properties and default values (wherever necessary), normalized and validated. In version 2021 Autumn, if there are invalid objects, the entry point of this webhook type is not reached. A validation exception is thrown before. As of version 2021 Winter, the following behavior is implemented:
The The objects returned by the webhook are normalized and validated again before the interrupted processing chain will be continued. Hence, by means of this webhook, it is not possible to introduce invalid objects into the system. Furthermore, the object list in the original request body cannot be completely overwritten. The following rules apply:
Considering the action code, the webhook might be allowed to change tags. In the audit trail, the tagging-related entry will be the same if the tag modification was specified in the original request or by means of the webhook, e.g.:
| ||||||||||||||||||
Requirements for External Endpoint | The target URL must be a POST endpoint accepting and returning a list of objects. | ||||||||||||||||||
Affected API Requests and Action Codes/History Codes |
| ||||||||||||||||||
Called by Service | REGISTRY service | ||||||||||||||||||
Header | Authorization-Header | ||||||||||||||||||
Example Request Body |
| ||||||||||||||||||
Example Predicate | Check if the object type is
|
...