The Kibo Platform generates an “Event” each time a user or application performs a “Create”, “Update”, or “Delete” operation. In KIBO’s Dev Center, a developer can configure external applications to subscribe to Events, such as when a new product is created or an existing order is updated. Using the API, applications can retrieve specific Event Notifications for a given tenant, catalog, or site. Because all events occur at the site level, if a tenant-level action occurs, such as the creation of a new customer account, then the system triggers the Event Notification for every site associated with the tenant. The kibo platform, generates an event each time a user or application performs, a create update or delete operation. In keebos Dev Center, a developer can configure external applications to subscribe to events such as when a new product is created or an existing order is updated. Using the API applications, can retrieve specific event notifications for a given tenant catalog or site. Because all events occur at the site level. If a tenant level action occurs such as the creation of a new customer account, then the system, triggers the event notification for every site associated with the tenant. To create an “Event Listener”, we’ll need to create a new “Application”. In KIBO’s Dev Center, click the “Develop” dropdown at the top of the page. Then click “Applications”. To create an “Event Listener”, we’ll need to create a new “Application”. In KIBO’s Dev Center, click the “Develop” dropdown at the top of the page. Then click “Applications”. This will take us to the “Applications” menu. All existing Applications will be listed here. To create a new Application, we’ll click the “Create Application” button on the top right. This will take us to the “Applications” menu. All existing Applications will be listed here. To create a new Application, we’ll click the “Create Application” button on the top right. This will open the “Create Application” modal window, where we’ll give the new Application a required “Name” and “Application ID”. In this example, we’ll call it “event_listener”. This will open the create application, modal window, where we’ll give the new application a required name and application ID. In this example, what we’ll call it event listener. On the new Application detail page, we’ll select the “Packages” tab on the left, and then click the “Events” tab. Then, we’ll click the “Add Event Subscription” button in this section. On the new Application detail page, we’ll select the “Packages” tab on the left, and then click the “Events” tab. Then, we’ll click the “Add Event Subscription” button in this section. This will open the “Add Event Subscription” modal. This modal provides all the necessary tools for configuring our “Event Subscription”, including specifying the “Endpoint” where events will be received, and which “Events” we want to monitor. This will open the “Add Event Subscription” modal. This modal provides all the necessary tools for configuring our “Event Subscription”, including specifying the “Endpoint” where events will be received, and which “Events” we want to monitor. Next, we’ll need to setup a Server to listen for Events. In this example, we’ll use the “Mock Server” feature in Postman.In Postman, on the left menu bar, select “Mock Servers”, then click “Create Mock Server”. Next, we’ll need to set up a server to listen for events. In this example, we’ll use the mock server feature in Postman. In postman, on the left, menu bar, select mock, servers, then, click create mock server. For our example, we’ll create a “Product Updated” Event. More endpoints can be added from the collection at a later time, if desired.We’ll create a “POST” endpoint. KIBO is expecting a two hundred response and does not expect a response body. Click “Next”. For our example, we’ll create a product updated event. More endpoints can be added from the collection at a later time. If desired, We’ll create a post endpoint kibo is expecting a 200 response and does not expect a response body, click next. “Name” the Mock Server, then click “Create Mock Server”. “Name” the Mock Server, then click “Create Mock Server”. Click “Copy Mock URL” to copy the generated endpoint. Click “Copy Mock URL” to copy the generated endpoint. Add the copied “Mock URL” to the Event Subscription “Endpoint” field. This connection allows the Event Listener to send notifications to the Mock Server, enabling us to verify that events are being triggered and received correctly. Add the copied “Mock URL” to the Event Subscription “Endpoint” field. This connection allows the Event Listener to send notifications to the Mock Server, enabling us to verify that events are being triggered and received correctly. “Disable Callbacks” is enabled by default. If we are authenticating and receiving events from the same application, however, we would need to disable this setting. For example, if the same application is being used to authorize and create orders, callbacks would need to be disabled in order to receive events for those orders created from that application. “Disable Callbacks” is enabled by default. If we are authenticating and receiving events from the same application, however, we would need to disable this setting. For example, if the same application is being used to authorize and create orders, callbacks would need to be disabled in order to receive events for those orders created from that application. Next, we’ll need to select which “Events” we want to be notified for. In this example, we’ll set up notifications for “Product Updates”.We’ll begin by selecting “Product” in the “Event Category” column on the left. A list of related “Events” will be displayed in the middle column. We’ll select “Product Updated”, then click “Save.” Next, we’ll need to select which “Events” we want to be notified for. In this example, we’ll set up notifications for “Product Updates”. We’ll begin by selecting “Product” in the “Event Category” column on the left. A list of related “Events” will be displayed in the middle column. We’ll select “Product Updated”, then click “Save.” Next, we’ll need to make sure the Application is installed on the Tenant we are looking to monitor. On the top right of the Application Detail Page, we’ll click the “Install” button. Next, we’ll need to make sure the Application is installed on the Tenant we are looking to monitor. On the top right of the Application Detail Page, we’ll click the “Install” button. This will open a modal with a list of Tenants. We’ll select the Tenants where we want to install this Application, then click “OK”. This will open a modal with a list of Tenants. We’ll select the Tenants where we want to install this Application, then click “OK”. Next, we’ll want to verify that the Application is installed on the selected Tenant, and make sure it is “Enabled”.In the Admin UI for the Tenant, in the left menu, on the “SYSTEM” tab, click “Customization”, then click “Applications”. Next, we’ll want to verify that the Application is installed on the selected Tenant, and make sure it is “Enabled”. In the Admin UI for the Tenant, in the left menu, on the “SYSTEM” tab, click “Customization”, then click “Applications”. All applications configured for this Tenant will be listed on the “Applications” menu. We’ll select our “event_listener” application here by clicking on it. All applications configured for this Tenant will be listed on the “Applications” menu. We’ll select our “event_listener” application here by clicking on it. To enable the new application, we’ll click the slider button on “Enable Application”. To enable the new application, we’ll click the slider button on “Enable Application”. Now the “Product Updated” Event Listener has been configured. To test it, we can navigate to any Product, update any Product detail, such as the “Description”, and click “Save”.To verify, return to Postman and view the event. Now the “Product Updated” Event Listener has been configured. To test it, we can navigate to any Product, update any Product detail, such as the “Description”, and click “Save”. To verify, return to Postman and view the event.
Want to learn more?
Event Notifications Overview
Learn more about this topic