Event Types and Sub-Types
What a consumer sends a message to the Event Ingress API they specify an Event Type and Sub-Type. This will identify to Fenergo what business process to invoke with the provided payload. This document outlines what Event Types and Sub-Type are and explains the available business processes which are invoked when messages arrive.
At any time a consumer can call the HTTP GET Event Types to return a list of OOTB and Configured event types available on their tenant.
Ingress Corelation Ids
As you will see in the Technical Overview which covers the API interfaces, you can provide a Correlation Id as part of the Ingres Message. This Id should be generated by the client and will be referenced again in the Success or Failure notification which is sent after the business process has completed.
Event Ingress Journey Trigger Conditions
In the Journey Configuration clients can specify Event Triggers as illustrated below. In this example you can see that an Onboarding Journey has been configured to execute when the Entity Type of externaldata and Sub-Type of createentity.
Ingress Journeys must be separate Journeys. The same journeys used through the UI or direct APIs cannot have Event Triggers. As soon as Event Triggers are added to a Journey it will ONLY be available to the Event Ingress Functionally. If a client wishes to use the same Journey for Ingress and the main application, it can be cloned and have one for the UI / Direct APIs and one for Event Ingress.
Business Processes
A Business Process is the set of orchestrated steps handled by Fenergo when an Event Ingress Message is received. Clients cannot add new Business Processes, they are implemented programmatically in our SaaS Platform and cover the two core scenarios of Creating an Updating a Legal Entity. The variation and flexibility comes from clients using the Event Type and SubType combinations (plus custom Types and Sub Types) to target any combination of Journey along with Create or Update business process.
Create Entity Business Process
A client can send a message which targets the createentity Business Process and Fenergo will orchestrate the following illustrated Steps. Each step will generate a notification and when the process is complete an Event Ingress Complete notification will be sent:
When sending an Ingress message to create an entity, no duplicate checks will be performed. These messages are NOT idempotent and will result in duplicate entity's if clients are not cautious in how they develop against this functionality.
Update Entity Business Process
A client can send a message which targets the updateentity Business Process and Fenergo will orchestrate the following illustrated steps. Each step below will generate a notification and when the process is complete an Event Ingress Complete notification will be sent:
The Entity Id is required when calling the Update Entity Ingress method. If the Entity does not exist on Fenergo this method will fail.
