---
schema_version: "1"
id: 3cdc8ec2f4b1229b7c6ef8a4155edb27defa53b3af9c3935087a8da9d2195551
title: InteropTopicSubscription
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/sforce_api_objects_interoptopicsubscription.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_interoptopicsubscription.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: b0e27fc743b1a99071710a43b1282b95a2c429e0f2ea0d033104bc302f3a7f3d
description: Represents a subscription to an interoperability topic. This object is available in API version 64.0 and later.
---
# InteropTopicSubscription

Represents a subscription to an interoperability topic. This object is available in API version 64.0 and later.

## Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

## Fields

### ChannelIdentifier

- **Type**: textarea
- **Properties**: Create, Nillable, Update
- **Description**: The identifier of the channel to which notifications are sent, such as an URL or email.

### ChannelTypeCodeId

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The code representing the type of channel used to send notifications for the interoperability topic subscription.
    
    This field is a relationship field.
- **Relationship Name**: ChannelTypeCode
- **Refers To**: CodeSet

### CheckInInterval

- **Type**: int
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The maximum interval, in seconds, before a check-in notification is sent to keep the subscription active when no new events occur.

### EffectiveEndDate

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: The last date when the interoperability topic subscription is effective.

### EffectiveStartDate

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: The first date when the interoperability topic subscription is effective.

### InteropTopicId

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The interoperability topic that's being subscribed to.
    
    This field is a relationship field.
- **Relationship Name**: InteropTopic
- **Refers To**: InteropTopic

### LastReferencedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The date when the interoperability topic subscription record was last referenced.

### LastViewedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The date when the interoperability topic subscription record was last viewed.

### MaximumEventCount

- **Type**: int
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The maximum number of events that can be bundled in a notification.

### Name

- **Type**: string
- **Properties**: Create, Filter, Group, idLookup, Sort, Update
- **Description**: The name of the interoperability topic subscription.

### NotificationTimeout

- **Type**: int
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The maximum amount of time, in seconds, to deliver a notifcation for the subscription.

### OwnerId

- **Type**: reference
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: The user who owns the interoperability topic subscription record.
    
    This field is a polymorphic relationship field.
- **Relationship Name**: Owner
- **Refers To**: Group, User

### PayloadContentType

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Specifies the type of content included in the notification payload.
- **Possible values**:
    - EMPTY—Empty
    - FULL\_RESOURCE—Full Resource
    - ID\_ONLY—ID Only

### PayloadFormatType

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies the format in which the notification payload for the subscription is sent.

### Reason

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The reason for the interoperability topic subscription.

### Status

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: The status of the interoperability topic subscription.
- **Possible values**:
    - ACTIVE—Active
    - ENTERED\_IN\_ERROR—Entered in Error
    - ERROR—Error
    - OFF—Off
    - REQUESTED—Requested

### SubscribedById

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The subscriber to the interoperability topic.
    
    This field is a polymorphic relationship field.
- **Relationship Name**: SubscribedBy
- **Refers To**: Account, HealthcareProvider

### SubscriberIdentifier

- **Type**: textarea
- **Properties**: Create, Nillable, Update
- **Description**: The unique identifier of the subscriber.

### SubscriberSystemIdentifier

- **Type**: string
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The unique identifier of the subscriber system.

## Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

[InteropTopicSubscriptionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")

Change events are available for the object.

[InteropTopicSubscriptionFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")

Feed tracking is available for the object.

[InteropTopicSubscriptionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")

History is available for tracked fields of the object.

[InteropTopicSubscriptionShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")

Sharing is available for the object.