DEX Webhook Handler

A utility package to register webhook events into a Postgres event queue.
It validates required environment variables and inserts events into the database transactionally.

🚀 Installation

npm install almaden-dex-webhook-handler

or with Yarn:

yarn add almaden-dex-webhook-handler

⚙️ Environment Variables

Before using the package, configure the following environment variables (in .env or in your environment):

PGHOST=""
PGUSER=""
PGPASSWORD=""
PGDATABASE=""
PGPORT=""
PG_MAX_CLIENTS=
PG_IDLE_TIMEOUT=
PG_CONNECTION_TIMEOUT=
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 { EEventName, DexWebhookHandler } from "almaden-dex-webhook-library";

const event: IWebhookEvent = {
customer_id: "123",
event_name: EEventName.DEX_USER_CREATED,
event_data: /*<data>*/
};

await DexWebhookHandler.submitWebhookEvent(transaction_obj, event);

Submit multiple events:

import { EEventName, DexWebhookHandler } from "almaden-dex-webhook-library";

const events = [
  {
    customer_id: "123",
    event_name: event_name: EEventName.DEX_USER_CREATED,
    event_data: /*<data>*/
  },
  {
    customer_id: "456",
    event_name: event_name: EEventName.DEX_USER_CREATED,
    event_data: /*<data>*/
  }
];

await DexWebhookHandler.submitWebhookEvents(transaction_obj, events);