Notification Webhooks

On-boarding Suite also provides a set of webhooks that can be used to get notifications when certain events of interest happen. The consumer will need to implement the contract of the web hook operation in an http web service and configure the URL to this web service

The steps to make use of the notification web hook feature are as follows:

Step 1: Create an Http Web service that implements the service operations associated with the notifications you are interested in. For example if you are interested in getting notifications when a journey is finished, you need to implement the NotifyJourneyFinished operation in the web service available by calling:

POST <UrlOfNotificationWebHookServiceRoot>/OnJourneyFinised

Step 2: Publish the web service and make it accessible to On-boarding Suite backend. Configure the URL that On-boarding should locate the service in the setting item with the key “JourneyNotificationWebhookUrl” in the BackendSettings.xml file.

Supported notification webhooks are:

• OnJourneyProgress notification

Invoked when an intermediate progress (events other than finishing the journey) occurs to a journey.

POST /OnJourneyProgress

Parameter	Description	Format
JourneyId Event	The identifier of the affected journey A string code identifier that represents what event happened to the journey. This designates a step in the Capture Journey. Exhaustive list of possible events that might occur will depend on the customisation done on the On-boarding Suite configuration. Some standard values common to most configurations are: EntryStarted: Fired when a new entry will be captured. EntryFinished: Fired when an entry finished capturing. BacksideNeeded: Fired when switching to the backside of an entry. CaptureRetry: Fired when the last capture was unsuccessful and a reattempt of capture is initiated.	A code value from a set of values represented in a string.

OnJourneyFinished notification

Invoked when a journey is fully completed. Usually this is the place to host and fire any integration logic that will consume the journey data. As any point earlier than the journey finish will not guarantee the consistency and completeness of journey data.

POST /OnJourneyFinished

Parameter	Description
JourneyId	The identifier of the affected journey

OnError notification
Invoked when an error occurs. If the error was associated with a specific journey, the relevant JourneyId is provided as well.

POST /OnJourneyError

Parameter	Description
JourneyId	The identifier of the journey that was affected by the error if the error was related to a journey. A code value representing the error that occurred encoded as a string value.
ErrorCode	Possible error codes are: • ProcessingError • ErrorSavingData • ServerError • JourneyViolation
ErrorDescription	A text message describing the error

• OnJourneyOverridden

invoked when journey overridden

POST /OnJourneyOverridden 

Parameter	Description
JourneyId	The identifier of the affected journey

valDecision a boolean that represent the decision, true means accepted, while false is Rejected.