almaden-itam-webhook-library
v1.0.4
Published
A utility package to register **webhook events** into a DB2 event queue. It validates required environment variables and inserts events into the database transactionally.
Readme
ITAM Webhook Handler
A utility package to register webhook events into a DB2 event queue.
It validates required environment variables and inserts events into the database transactionally.
🚀 Installation
npm install almaden-itam-webhook-handleror with Yarn:
yarn add almaden-itam-webhook-handler⚙️ Environment Variables
Before using the package, configure the following environment variables (in .env or in your environment):
DB_STRING_AUTOM02=""
DB_STRING_ASSET=""
WEBHOOK_API_ADDRESS=""PS: If any of these variables are missing, the package will throw an error during execution.
📦 Usage
Submit a single event:
import { EDatabase, EEventName, ItamWebhookHandler } from "almaden-itam-webhook-library";
const transaction_obj = await DB2.open_transaction(EDatabase.AUTOM02_DATABASE);
const event: IWebhookEvent = {
customer_id: "123",
event_name: EEventName.ITAM_USER_CREATED,
event_data: /*<data>*/
};
await ItamWebhookHandler.submitWebhookEvent(transaction_obj, EDatabase.AUTOM02_DATABASE, event);Submit multiple events:
import { EDatabase, EEventName, ItamWebhookHandler } from "almaden-itam-webhook-library";
const transaction_obj = await DB2.open_transaction(EDatabase.ASSET_DATABASE);
const events = [
{
customer_id: "123",
event_name: event_name: EEventName.ITAM_USER_CREATED,
event_data: /*<data>*/
},
{
customer_id: "456",
event_name: event_name: EEventName.ITAM_USER_CREATED,
event_data: /*<data>*/
}
];
await ItamWebhookHandler.submitWebhookEvents(transaction_obj, EDatabase.ASSET_DATABASE, events);