Mediloop
CONNECTOR SDK REFERENCE3 of 10

Method Reference

Detailed reference for all methods in the Mediloop Connector Interface.

Before you start
All methods receive a ConnectorContext as the first parameter. All timestamps are ISO 8601 UTC.
ConnectorContextHealthStatusConnectorCapabilitiesReadResponse<T>SearchResponse<T>WriteResponseEventEnvelopePromise<void>

Methods

1initialize(context)Initialize connectorSince 1.0.0
2getCapabilities()Declare supported capabilitiesSince 1.0.0
3connect()Establish connectionSince 1.0.0
4disconnect()Close connectionsSince 1.0.0
5healthCheck()Return health statusSince 1.0.0
6read(resourceType, id, options?)Read a resourceSince 1.0.0
7search(resourceType, query, options?)Search resourcesSince 1.0.0
8write(resourceType, payload, options?)Create or update a resourceSince 1.0.0
9subscribe(events)Subscribe to eventsSince 1.0.0
10onEvent(event)Handle incoming eventsSince 1.0.0
11handleError(error, context)Centralized error handlingSince 1.0.0
initialize()getCapabilities()search()write()
typescriptCopy
async initialize(context: ConnectorContext): Promise<void> {
  if (!context.config.baseUrl) {
    throw new MediloopConnectorError('MISSING_CONFIG', 'Base URL is required');
  }
  this.http = new HttpClient({
    baseUrl: context.config.baseUrl,
    timeout: context.config.timeout ?? 30000,
  });
  this.logger.info('Connector initialized', { tenantId: context.tenantId });
}

Method details — initialize(context)

Signatureinitialize(context: ConnectorContext): Promise<void>
CalledOnce, when the connector is created or restarted
DescriptionValidate config, initialize clients, allocate resources and prepare internal state
contextConnectorContext — Required
context.tenantIdstring
context.environmentsandbox | production
context.configConnectorConfiguration
context.loggerStructuredLogger
ReturnsPromise<void>
ThrowsMediloopConnectorError — Invalid config
NetworkErrorNetwork or connectivity issues
AuthenticationErrorAuth failure during initialization