Getting Started with Webhooks and Callbacks API

Introduction

A comprehensive API demonstrating webhooks and callbacks patterns.

Webhooks

Webhooks allow your application to receive real-time notifications when certain events occur.

Callbacks

Callbacks are used for asynchronous operations where the API will call back to your provided URL when the operation completes.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | timeout | number | Timeout for API calls.Default: 50000 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | apiKeyCredentials | ApiKeyCredentials | The credential object for apiKey | | bearerAuthCredentials | BearerAuthCredentials | The credential object for bearerAuth |

The API client can be initialized as follows:

Code-Based Client Initialization

import { Client, LogLevel } from 'package-wesley-key-ts-new';

const client = new Client({
  apiKeyCredentials: {
    'X-API-Key': 'X-API-Key'
  },
  bearerAuthCredentials: {
    accessToken: 'AccessToken'
  },
  timeout: 50000,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'package-wesley-key-ts-new';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'package-wesley-key-ts-new';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

• ApiKey (Custom Header Signature)
• BearerAuth (OAuth 2 Bearer token)

List of APIs

• Orders

Webhooks

• Webhooks
• Webhooks A
• Webhooks B
• Webhooks C
• Webhooks No Verification

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError