Event Subscription

This service allows a partner application to receive, by a Webhook. notifications or full payload of subscribed events generated by Keyloop DMSs. The process of subscribing to the event streams is currently managed by Keyloop and partners should provide an endpoint to the specification provided to allow the streaming of business events.This service will have the benefit of ensuring that a partner application is kept informed and aligned with the DMS.

EVENT TYPES

All events will be delivered as Cloud Events. Cloud Events define a common data structure for event payloads, making it easier to pass event information between different cloud services, event sources, and event consumers. It aims to promote interoperability and compatibility across cloud providers and services.

This service provides 2 types of events subscription:

Notification: When the notification is received this allows for subsequent queries to be built upon to obtain the associated object using our API portfolio.

Integration: full payload of subscribed event (Customer, Vehicle, etc) is sent to partners without the need of subsequent API queries. *This event type is not available in all business events yet.

WHAT IS A WEBHOOK?

A webhook is a way for two different systems or applications to communicate with each other in real-time. Specifically, a webhook is a method for sending automated messages or notifications from one system to another whenever a specific event occurs.

When a webhook is set up, the first system (the one generating the events) sends a message to a designated URL on the second system (the one receiving the notifications). The second system then responds to the message, usually by triggering some kind of automated action or process based on the information in the message.

Webhooks are commonly used to integrate different software systems or to automate workflows between them.

ENDPOINT SPECIFICATION

Partner needs to provide 2 endpoints (receiving http request):

Authentication URL: AUTH0 authentication that will provide Keyloop a token (provided “client_id”, “client_secret” and “audience” will be used. “grant_type” must be set to “client_credentials”)

Post URL: for receiving the event (Notification or Integration). Acquired token from Authentication URL will be used to secure the connection.

Customer

Availability: Drive, Autoline & Automaster

Event Types: Notification & Integration

Set up and update single or multiple subscriptions to Customer Events: Customer Created, Customer Updated and Customer Deleted

Use alongside Customer API products (Manage Customer, Find Customer, Manage Customer Privacy) to retrieve the applicable customer data

Vehicle

Availability: Drive, Autoline & Automaster

Event Types: Notification & Integration

Set up and update single or multiple subscriptions to Vehicle Events: Vehicle Created, Vehicle Updated and Vehicle Deleted

Use alongside Vehicle API products to retrieve the applicable Vehicle data.

Repair Order

Availability: Drive, Autoline & Windrakar

Event Types: Notification

Set up single or multiple subscriptions to Repair Order Events: Repair Order Created, Repair Order Updated and Repair Order Cancelled

Use alongside Inspect Vehicle API products (Inspect Vehicle Basic and Inspect Vehicle Advanced) to retrieve applicable repair order data

Epayment

Availability: Drive, Autoline, EVA & Windrakar

Event Types: Notification

Set up single subscriptions to Epayment Events: Initiated and Cancelled.

Use Payment APIs product to get the payment details and update back the payment status to DMS

CRM Database

• Keep your CRM database up to date
• Save multiple API calls to the DMS by only calling when required (only call when the customer has been created or updated) and only the applicable customer (not mass calls to whole customer database)
• Act upon the information given e.g. launch campaigns, serve customers on up to date information, data cleansing

Process

• Partner provides URL to Keyloop specification
• Keyloop sets up subscription to relevant enterprises/stores

Repair

• Keep your applications up to date with the latest repair order data
• Save on making unnecessary multiple API calls to the DMS by only calling when required (only call when repair order event is notified) and only with the applicable repair order
• Act upon the information given e.g. inform customers on up to date service progress information