System URLs
Type
callback: The extId is posted to the callback URLs ex. { extId: ”…” }
State
State
Description
Note
started
Process was started / User clicked on link
error
User failed the process
Not applicable to QES
sucess
Process succeeded
warn
User finished the process un- nor successful.
Not applicable to QES
abort
User aborted the process
Is triggered when clicking on (x)
session-expired
Process URL has expired
Triggered when the JWT token expires and for incomplete processes
Example:
Following example payload counts for all types:
"systemUrls": [
{
"url": "https://webhook.site/abcd-0000-1111-2222-3333",
"type": "callback",
"state": "success"
},
If the callback URLs are not accessible, the resposibility is on the customers side (queue etc.): A retry mechanism is missing so far. With the callbacks, we call the customer backend. The integrator ensures that the endpoint is always reachable.
Last updated