Class AppWebhook

AppWebhook class for managing application webhook configurations

This class represents a webhook configuration that enables external systems to receive notifications about application events. AppWebhooks handle webhook URLs, event types, and integration configuration for receiving notifications from the Mosaia platform.

Features:

  • Webhook URL management
  • Event type configuration
  • Secret key handling for webhook security
  • Active/inactive status management
  • External system integration

Remarks

AppWebhooks are particularly useful for:

  • External system notifications
  • Event-driven integrations
  • Real-time application updates
  • Third-party service integrations
  • Secure webhook delivery

Example

Basic webhook setup:

import { AppWebhook } from 'mosaia-node-sdk';

// Create a webhook for request events
const webhook = new AppWebhook({
  app: 'app-id',
  url: 'https://myapp.com/webhook',
  events: ['REQUEST'],
  secret: 'webhook-secret-key'
});

await webhook.save();
console.log('Webhook URL:', webhook.url);

Example

Advanced webhook configuration:

// Create a webhook with multiple event types
const webhook = new AppWebhook({
  app: 'app-id',
  url: 'https://api.example.com/webhooks',
  events: ['REQUEST', 'RESPONSE'],
  secret: 'secure-secret-key',
  active: true,
  external_id: 'external-webhook-id',
  extensors: {
    environment: 'production',
    team: 'engineering'
  }
});

// Configure and activate
await webhook.save();
if (webhook.active) {
  console.log('Webhook is active:', webhook.url);
}

Hierarchy (View Summary)

Constructors

constructor

Methods

isActive toJSON toAPIPayload update save delete

Constructors

constructor

  • new AppWebhook(data: Partial<AppWebhookInterface>, uri?: string): AppWebhook

    Creates a new AppWebhook instance

    Initializes a webhook configuration that enables external systems to receive notifications about application events. The webhook manages URL, event types, and security configuration.

    Parameters

    • data: Partial<AppWebhookInterface>

      Configuration data including: - app: Parent application ID - url: Webhook endpoint URL where notifications will be sent - events: Array of event types to subscribe to - secret: Optional secret key for webhook authentication - active: Whether the webhook is currently active - external_id: Optional external system identifier - extensors: Optional custom metadata object

    • Optionaluri: string

      Optional custom URI path for the webhook endpoint

    Returns AppWebhook

    Example

    Basic webhook:

    const webhook = new AppWebhook({
      app: 'app-123',
      url: 'https://api.example.com/webhook',
      events: ['REQUEST']
    });

    Example

    Advanced configuration:

    const webhook = new AppWebhook({
      app: 'app-123',
      url: 'https://api.example.com/webhooks',
      events: ['REQUEST', 'RESPONSE'],
      secret: 'webhook-secret',
      active: true,
      external_id: 'ext-123',
      extensors: {
        platform: 'slack',
        channel: 'notifications'
      }
    }, '/integrations/webhook');

Methods

isActive

  • isActive(): boolean

    Check if the entity is active

    This method checks the active status of the entity. Most entities in the system can be active or inactive, which affects their availability and usability in the platform.

    Returns boolean

    True if the entity is active, false otherwise

    Example

    const user = new User(userData);
    if (user.isActive()) {
      // Perform operations with active user
    } else {
      console.log('User is inactive');
    }

toJSON

  • toJSON(): AppWebhookInterface

    Convert model instance to interface data

    This method serializes the model instance to a plain object that matches the interface type. This is useful for:

    • Sending data to the API
    • Storing data in a database
    • Passing data between components
    • Debugging model state

    Returns AppWebhookInterface

    The model data as a plain object matching the interface type

    Example

    const user = new User({
      email: 'user@example.com',
      firstName: 'John'
    });

    const data = user.toJSON();
    console.log(data); // { email: '...', firstName: '...' }

    // Use with JSON.stringify
    const json = JSON.stringify(user);

toAPIPayload

  • toAPIPayload(): Partial<AppWebhookInterface>

    Convert model instance to API payload

    This method creates a payload suitable for API requests by:

    • Converting the model to a plain object
    • Removing read-only fields (like 'id')
    • Ensuring proper data format for the API

    Returns Partial<AppWebhookInterface>

    A clean object suitable for API requests

    Example

    const user = new User({
      id: '123',           // Will be removed from payload
      email: 'new@example.com',
      firstName: 'John'
    });

    const payload = user.toAPIPayload();
    // payload = { email: '...', firstName: '...' }
    // Note: 'id' is removed as it's read-only

    await apiClient.POST('/users', payload);

update

  • update(updates: Partial<AppWebhookInterface>): void

    Update model data with new values

    This method updates the model's data and instance properties with new values. It performs a shallow merge of the updates with existing data, allowing for partial updates of the model's properties.

    Parameters

    Returns void

    Example

    const user = new User({
      email: 'old@example.com',
      firstName: 'John'
    });

    // Update multiple properties
    user.update({
      email: 'new@example.com',
      lastName: 'Doe'
    });

    // Save changes to API
    await user.save();

    Remarks

    This method only updates the local model instance. To persist changes to the API, call save after updating.

save

  • save(): Promise<AppWebhookInterface>

    Save the model instance to the API

    This method persists the current state of the model to the API using a PUT request. It requires the model to have an ID (existing instance). For new instances, use the collection's create method instead.

    The method:

    1. Validates the model has an ID
    2. Sends current data to the API
    3. Updates local instance with API response

    Returns Promise<AppWebhookInterface>

    Promise resolving to the updated model data

    Throws

    When model has no ID

    Throws

    When API request fails

    Example

    const user = new User({
      id: '123',
      email: 'user@example.com'
    });

    // Update and save
    user.update({ firstName: 'John' });
    await user.save();

    Example

    Error handling:

    try {
      await user.save();
    } catch (error) {
      if (error.message.includes('ID is required')) {
        // Handle missing ID error
      } else {
        // Handle API errors
      }
    }

delete

  • delete(): Promise<void>

    Delete the model instance from the API

    This method permanently deletes the model instance from the API and clears the local data. This operation cannot be undone.

    The method:

    1. Validates the model has an ID
    2. Sends DELETE request to the API
    3. Clears local instance data on success

    Returns Promise<void>

    Promise that resolves when deletion is successful

    Throws

    When model has no ID

    Throws

    When API request fails

    Example

    Basic deletion:

    const user = await users.get({}, 'user-id');
    if (user) {
      await user.delete();
      // User is now deleted and instance is cleared
    }

    Example

    Error handling:

    try {
      await user.delete();
      console.log('User deleted successfully');
    } catch (error) {
      if (error.message.includes('ID is required')) {
        console.error('Cannot delete - no ID');
      } else {
        console.error('Deletion failed:', error.message);
      }
    }

Settings

Member Visibility

On This Page

Constructors
Methods