Create Integration Definitions for Integration Orchestration
An integration definition is a framework to set up integrations with different external endpoints quickly and efficiently.
Required Editions
| Available in Lightning Experience in Enterprise, Professional, and Unlimited Editions |
| User Permissions Needed | |
|---|---|
| To create Apex Defined integration definitions: | Customize Application |
| To setup integration orchestration: | Integration Orchestration User |
You can call the integration definition from an invocable action within a flow or from an integration procedure in an Omniscript. You can use an integration definition in an invocable action within a Salesforce Flow or from an integration procedure in an Omniscript or Flex card.
- In Setup, in the Quick Find box, enter Integration Definitions, and then select Integration Definitions.
- Click New.
-
From the Type list, select the integration type.
- Apex Defined: This approach gives you greater control over the API call out. The endpoint configuration and the input and output processors are handled in an Apex class.
- External Services Defined: A low-code, declarative approach to connect Salesforce with an external endpoint. You can define the input processor that prepares the input to the external service and the output processor to handle the response from the external service. The input and output processors are integration procedures.
- Enter the integration definition name, developer name, and description.
- Click Next.
-
For the External Services Defined integration type, enter this information:
- Search for the registered external service that you want to use to connect to an external API.
- For Input Processor, select the integration procedure that you want to use to format the input for the selected external service.
- For Output Processor, select the integration procedure that you want to use to handle the response from the external service.
- Enable Integration Orchestrator.
- Select the Integration Execution Mode.
-
Select the checkbox to save the request and response as attachments to the record.
Important . Content publish limits are applicable to save the request and responses as attachments. See Salesforce CRM Content Limits.
Important To securely store sensitive information, deploy Shield Platform Encryption. - Select the checkbox to configure Service Type integration, or leave it unchecked for Process Type integration.
- Save your changes.
- From the integration definition’s quick action menu, click Activate.
- Save and activate the integration definition.
Did this article solve your issue?
Let us know so we can improve!

