IntegArtifactDef

Represents a custom flow connector that you can use to extend flows to an external service.

This type extends Metadata and inherits its fields.

IntegArtifactDef components have the suffix .integArtifactDef and are stored in the integArtifactDefs folder.

Introduced in API version 66.0.

Only users with the CustomConnectors permission can access this metadata type.

• Type: string
• Required: Yes
• Description: Required. The detailed text description of the integration artifact’s overall purpose and functionality.

• Type: string
• Required: Yes
• Description: Required. The name of the integration artifact.

• Type: string
• Required: Yes
• Description: Required. The identifier that groups related integration artifacts.

• Type: string
• Required: No
• Description: The name of the icon for the integration artifact.

• Type: boolean
• Required: No
• Description: Indicates whether the integration artifact is global. A value of true indicates that the artifact is global. A value of false indicates that the artifact isn’t global.

This XML is an example of an IntegArtifactDef component.

1<?xml version="1.0" encoding="UTF-8"?>
2<IntegArtifactDef xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>Connects Salesforce Flow to MySystem</description>
4    <displayName>My Connector</displayName>
5    <groupId>com.example.myconnector</groupId>
6    <iconName>MyConnectorIcon</iconName>
7    <isGlobal>true</isGlobal>
8</IntegArtifactDef>

This XML is an example package.xml file 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>IntegArtifactDef</name>
6    </types>
7    <version>68.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.