Creating a third-party service

Third-party service setup

Following the instructions here to properly integrate your service with the agent workspace. First, install the app package:

% npm install --save @amazon-connect/app

Then, add the following initialization code to your app:

import { AmazonConnectService } from "@amazon-connect/app";

const { provider } = AmazonConnectService.init({
  onCreate: (event) => {
    const { instanceId } = event.context;
    console.log('Service creation complete: ', instanceId);
  }
});

When building a third-party service:

Here is an example of proper initialization with timeout handling:

import { AmazonConnectService } from "@amazon-connect/app";

export function initService() {
  AmazonConnectService.init({
    onCreate: async (event) => {
      // This is where you set up your service's functionality
      // Add all of your service setup code here - examples include:
      // - Set up event listeners
      // - Establish connections
      // - Load configurations
      // - etc.
      let timeoutId: NodeJS.Timeout;
      
      const INIT_TIMEOUT = 25000; // 25 seconds
      const { context } = event;
      const { instanceId } = event.context;
      const provider = context.getProvider();
      
      const cleanup = () => {
        if (timeoutId) {
          clearTimeout(timeoutId);
        }
        // Add any other cleanup logic here
        // For example: close connections, remove event listeners, etc.
      };

      try {
        // Create a promise that will reject after the timeout
        const timeoutPromise = new Promise((_, reject) => {
          timeoutId = setTimeout(() => {
            reject(new Error('Service creation timed out'));
          }, INIT_TIMEOUT);
        });

        // Race between your code and the timeout
        await Promise.race([
          executeServiceCode(),
          timeoutPromise
        ]);
        
        console.log('Service creation complete: ', instanceId);

      } catch (error) {
        console.error('Service creation failed:', error);
        // Send fatal error to terminate the service
        provider.sendFatalError('Service creation failed');
      } finally {
        cleanup();
      }
    }
  });
}

async function executeServiceCode() {
  // Your service implementation goes here
  console.log('Executing service code');
}

initService();

AWS console setup

Create a new third-party service by creating a third-party application with the following settings either via APIs or in the AWS Console: