Notifications

Notifications

REST

The Notifications API provides functionality to deliver notifications and event updates within the IITC ecosystem.

Description

The Notifications API enables the delivery and management of asynchronous event notifications within the IITC platform, allowing client applications to receive status updates for orders, bulk executions, and related processes.

Use Cases

The Orders API may be used by client applications wishing to:

Receive asynchronous notifications for lifecycle events and status changes related to orders, bulk processes, and other IITC platform activities.

Be informed of the progress, completion, or failure of long‑running or asynchronous operations.

Consume standardized event updates to keep client systems synchronized with the IITC platform state.

Enable reliable callback mechanisms for event‑driven integrations.

Improve observability and transparency of backend processes without relying on synchronous polling.

Resources

Key features

This API enables users to :

  • Deliver asynchronous notifications and event updates across the IITC ecosystem.
  • Notify client applications of lifecycle events and status changes for orders, bulk processes, and related operations.
  • Support event‑driven integrations through standardized callback mechanisms.
  • Ensure reliable and decoupled propagation of platform events.
  • Improve visibility and observability of asynchronous and long‑running processes.

Complementary Information

Notifications APIs describe notifications sent to Client application (OEM) and are also known as outbound APIs. The activation of the outbound notifications needs to be enabled during OEM onboarding. Upon receiving request from IITC Platform Client application should respond with HTTP 200 response otherwise IITC Platform will retry up to 5 times after the initial attempt at 60 seconds interval. The request will be marked as failed delivery if the retry attempts are exhausted. Outbound APIs will receive requests from IITC Platform to push event notifications towards Client application (OEM). The 3rd Party’s endpoint, authentication type and the authorization credentials are provided by IITC Platform in the notification request. Authentication can be of folowing types depending on the target endpoint: •Basic Authentication •OAuth2.0 Authentication •Two-Way TLS authentication •Api Key Basic Authentication will add a Basic Authorization header with the authorization credentials encoded in Base64 to the notification request sent to the customer endpoint. OAuth2.0 Authentication will be handled by making a request to the customers OAuth server providing the clientId and clientSecret in order to obtain an OAuth Token. This OAuth Token is stored in the API cache in order to be reused in every request to that customer, when the token expires another request is sent to obtain a new OAuth Token. The notification request is sent after obtaining the OAuth token with the token set in the authorization header as a bearer token. Two-Way TLS authentication, both the TLS client (APIHUB) and the server (OEM backend) maintain a keystore with their own cert and private key used for mutual authentication. Api Key authentication consists in using a unique code that is passed in to an API to identify the calling application in order to track and control how the API is being used.