The Integration Entity
Integration
Catalytic.SDK.Entities.Integration
The Integration entity contains metadata about Integrations in the Catalytic platform.
Common Properties
These are the most commonly used properties of an Integration.
| Name | Type | Description |
|---|---|---|
Id | string | The unique ID of the Integration |
Name | string | The name of the Integration |
IsCustomIntegration | bool | Boolean indicating whether Integration is a built-in Catalytic Integration or a custom Integration |
Connections | List<IntegrationConnection | List of IntegrationConnections to this Integration |
ConnectionParams | List<Field> | List of values required to create a new Connection of this Integration |
Instance Methods
| Name | Return Type | Description |
|---|---|---|
CreateConnectionRequest | IntegrationConnectionCreationRequest | Constructs an IntegrationConnectionCreationRequest used to Create an IntegrationConnection |
The CreateConnectionRequest Instance Method
CreateConnectionRequest Instance MethodIntegrationConnectionCreationRequest CreateConnectionRequest(string name, IEnumerable<KeyValuePair<string, object>> connectionParams);
| Parameter | Type | Description |
|---|---|---|
name | string | The display Name to apply to the Integration Connection |
connectionParams | IEnumerable<KeyValuePair<string, object>> | The ConnectionParams required to create a new Integration Connection, keyed by Name. Should mirror the ConnectionParams on the Integration. |
| returns | IntegrationConnectionCreationRequest | The constructed IntegrationConnectionCreationRequest |
Updated about 4 years ago