Service Integration Provider Interface

The ServiceIntegrationProvider interface specifies three methods that you must implement before you create an integration definition.

Required Editions

Available in: Lightning Experience
  • getCalloutRequest
  • getCalloutResponse
  • getProviderAttributes

getCalloutRequest ()

Description: Generates an IntegrationCalloutRequest to initiate a continuation callout.

Input Parameters:

  • requestId: An identifier for the request.
  • params: A map that contains additional information to communicate with the external system. For example, {“recordId”: “AxCxxxxxx”, “recordType”: “SavingsAccount”}.
  • attributes: A set of configuration attributes that you can set when you create or update an integration definition.

Output: Returns an IntegrationCalloutRequest object.

getCalloutResponse ()

Description: Processes the list of HTTP responses and generates an IntegrationCalloutResponse object.

Input Parameters:

  • httpResponseList: A list that contains HTTP responses.
  • state: The state of the continuation callout that’s set in IntegrationCalloutRequest.
  • attributes: A set of configuration attributes that you can set when you create or update an integration definition.

Output: Returns an IntegrationCalloutResponse object. true on successful completion, false for any other errors, along with the error message.

getProviderAttributes ()

Description: Retrieves the default list of ApexProviderAttr from the provider.

Input Parameters: None

Output: Returns a list of ApexProviderAttr objects.