IntegrationProviderDef

Represents an integration definition associated with a service process. Stores data for the Industries: Send Apex Async Request and Industries: Send External Async Request invocable actions.

This type extends Metadata and inherits its fields.

IntegrationProviderDef components have the suffix .integrationProviderDefinition and are stored in the .integrationProviderDefinition folder.

Introduced in API version 57.0.

Access to the IntegrationProviderDef type requires the AccessToServiceProcess permission.

• Type: boolean
• Required: No
• Description: Specifies whether this Integration Definition is active. The default is false.

• Type: string
• Required: No
• Description: The custom Apex class that the related Industries: Send Apex Async Request invocable action invokes. Specify either apexClass or fileBasedApexClass but not both. Applies only if the type is Apex.

• Type: string
• Required: No
• Description: A meaningful explanation of the Integration Definition.

• Type: string

• Required: Yes

• Description: Required.

  A system name for the Integration Definition.

• Type: string
• Required: No
• Description: The external service operation that the related Industries: Send External Async Request invocable action invokes. Applies only if the type is LowCode.

• Type: string
• Required: No
• Description: The external service that the related Industries: Send External Async Request invocable action invokes. Applies only if the type is LowCode.

• Type: string
• Required: No
• Description: The Salesforce-provided Apex class that the related Industries: Send Apex Async Request invocable action invokes. Specify either apexClass or fileBasedApexClass but not both. Applies only if the type is Apex.

• Type: string
• Required: No
• Description: The Salesforce-provided external service that the Integration Definition invokes. This field is used for packaged or system-provided external service integrations. Applies only if the type is LowCode.

• Type: string
• Required: No
• Description: The Salesforce-provided Integration Procedure that processes the specified data. This field references packaged or system-provided data processors. Applies only if the type is LowCode.

• Type: string
• Required: No
• Description: The Salesforce-provided OmniStudio UI Card that’s associated with this Integration Definition. This enables packaged UI components for integration configuration.

• Type: string
• Required: No
• Description: The Salesforce-provided Integration Procedure that processes the returned data. This field references packaged or system-provided output processors. Applies only if the type is LowCode.

• Type: string
• Required: No
• Description: The optional Integration Procedure that processes the sent data. Applies only if the type is LowCode.

• Type: IntegrationProviderAttr[]
• Required: No
• Description: Custom attributes that store data associated with an Integration Definition.

• Type: string
• Required: No
• Description: Name of the Java class that the Integration Definition invokes. Applies only if the type is Java.

• Type: string
• Required: No
• Description: The optional Integration Procedure that processes the returned data. Applies only if the type is LowCode.

• Type: string

• Required: Yes

• Description: Required.

  A meaningful name for the Integration Definition.

• Type: DefinitionType (enumeration of type string)

• Required: Yes

• Description: Required.

  What the Integration Definition calls, either an Apex class or an external service.

  Values are:

• Possible values:

  • Apex
  • Java
  • LowCode

A custom attribute that stores data associated with an Integration Definition.

• Type: AttrDataType (enumeration of type string)

• Required: Yes

• Description: Required.

  The data type of the attribute.

  Values are:

• Possible values:

  • Date
  • DateTime
  • Double
  • Integer
  • Percentage
  • String
  • Boolean

• Type: dateTime
• Required: No
• Description: The value of the attribute if the dataType is DateTime.

• Type: date
• Required: No
• Description: The value of the attribute if the dataType is Date.

• Type: string
• Required: No
• Description: A meaningful explanation of the attribute.

• Type: string

• Required: Yes

• Description: Required.

  A system name for the attribute.

• Type: double
• Required: No
• Description: The value of the attribute if the dataType is Double.

• Type: int
• Required: No
• Description: The value of the attribute if the dataType is Integer.

• Type: string

• Required: Yes

• Description: Required.

  A meaningful name for the attribute.

• Type: double
• Required: No
• Description: The value of the attribute if the dataType is Percentage.

• Type: boolean

• Required: Yes

• Description: Required.

  Specifies whether the attribute is required.

• Type: string
• Required: No
• Description: The value of the attribute if the dataType is String.

• Type: boolean
• Required: No
• Description: The value of the attribute if the dataType is Boolean.

The following is an example of an IntegrationProviderDef component.

1<?xml version="1.0" encoding="UTF-8"?>
2<IntegrationProviderDef xmlns="http://soap.sforce.com/2006/04/metadata">
3   <developerName>EmailUpdate</developerName>
4   <providerLabel>EmailUpdate</providerLabel>
5   <type>Apex</type>
6   <apexClass>SendEmailUpdate</apexClass>
7   <integrationProviderAttributes>
8      <developerName>EmailAddress</developerName>
9      <label>EmailAddress</label>
10      <dataType>String</dataType>
11      <stringValue>person@example.com</stringValue>
12      <required>true</required>
13   </integrationProviderAttributes>
14</IntegrationProviderDef>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>IntegrationProviderDef</name>
6    </types>
7    <version>57.0</version>
8</Package>

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.