ExternalServiceRegistration

Represents the External Service configuration for an org. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ExternalServiceRegistration components have the suffix .externalServiceRegistration and are stored in the externalServiceRegistrations folder.

Version

ExternalServiceRegistration components are available as a Beta release in API version 39.0.

This release contains a beta version of External Services, which means it’s a high-quality feature with known limitations. This feature isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for External Services in the IdeaExchange Platform Integration group in the Trailblazer Community.

Note

Fields

Field Name	Field Type	Description
description	string	Required. The external service description defined when the service is created.
label	string	The service name as it appears on the External Services wizard.
namedCredential	string	Required. The reference of the named credential to be used for the service.
schema	string	Required. The content of the JSON schema in the Interagent format. Nillable.
schemaType	string	Required. ID format of the schema, which is InteragentHyperSchema. Nillable.
schemaUrl	string	Required. The schema URL defined when registering a service. The path should begin with “/” and be a relative path.
status	string	Indicates whether the service registration is finished (complete) or not (incomplete).

Declarative Metadata Sample Definition

The following is an example of an ExternalServiceRegistration component that references an external credit service.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalServicesRegistration xmlns="http://soap.sforce.com/2016/11/metadata">
3        <label>creditService</label>
4        <namedCredential>AcmeCreditService</namedCredential>
5        <schema>/schema</schema>
6        <schemaType>InteragentHyperSchema</schemaType>
7	 <schemaUrl>http://interagent.github.io/interagent-hyper-schema</schemaUrl>
8	 <status>complete</status>
9</ExternalServicesRegistration>

Metadata API Developer Guide

ExternalServiceRegistration

File Suffix and Directory Location

Version

Fields

Declarative Metadata Sample Definition