Integrationconfigs

Retrieve IntegrationConfig

Function name: m3ter_GetIntegrationConfigForType Category: READ HTTP method: GET Destination: m3ter Retrieve the integration configuration for the entity

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`entityType`	entityType	LookupParameter	Yes	The entity to retrieve the configuration for.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: entityId,destination,destinationId

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Available Auth Config for System and Entity Type

Function name: m3ter_GetAvailableAuthForSystemAndEntityType Category: READ HTTP method: GET Destination: m3ter Retrieve the valid auth config for provided system and entity type.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`systemName`	systemName	LookupParameter	Yes	The system to retrieve the configuration for.	-
`entityType`	entityType	LookupParameter	Yes	The entity to retrieve the configuration for.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

List All IntegrationConfigs

Function name: m3ter_GetIntegrationConfigs Category: READ HTTP method: GET (paginated) Destination: m3ter List all integration configurations. This endpoint retrieves a list of all integration configurations for the specified Organization. The list can be paginated for easier management.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: destinationId

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Create IntegrationConfig

Function name: m3ter_PostIntegrationConfig Category: WRITE HTTP method: POST Destination: m3ter Set the integration configuration for the entity.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Enable IntegrationConfig

Function name: m3ter_EnableIntegrationConfig Category: WRITE HTTP method: POST Destination: m3ter Enables a previously disabled integration configuration, allowing it to be operational again.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	UUID of the integration configuration	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve IntegrationConfig for UUID

Function name: m3ter_GetIntegrationConfig Category: READ HTTP method: GET Destination: m3ter Retrieve the integration configuration for the given UUID. This endpoint retrieves the configuration details of a specific integration within an organization. It is useful for obtaining the settings and parameters of an integration.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the integration configuration. This ID specifies which integration’s configuration details are being requested.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Update IntegrationConfig

Function name: m3ter_UpdateIntegrationConfig Category: WRITE HTTP method: PUT Destination: m3ter Update the integration configuration for the given UUID. This endpoint allows you to update the configuration of a specific integration within your organization. It is used to modify settings or parameters of an existing integration.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the IntegrationConfig. This ID identifies which specific integration configuration you wish to update.	-
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Delete IntegrationConfig

Function name: m3ter_DeleteIntegrationConfig Category: WRITE HTTP method: DELETE Destination: m3ter Delete the integration configuration for the given UUID. Use this endpoint to delete the configuration of a specific integration within your organization. It is intended for removing integration settings that are no longer needed.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the IntegrationConfig to be deleted. This ID specifies the exact integration configuration that needs removal.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Get ConfigOption Values

Function name: m3ter_GetConfigOptionValues Category: READ HTTP method: GET Destination: m3ter Get possible values for specific configuration setting.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`systemName`	systemName	LookupParameter	Yes	The name of the system.	-
`configOption`	configOption	LookupParameter	Yes	The entity to retrieve the configuration for.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Available Configurations

Function name: m3ter_GetAvailableConfig Category: READ HTTP method: GET Destination: m3ter This endpoint gets the available configuration options for integrations.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: systemName,entityType

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Available Integration Systems

Function name: m3ter_GetAvailableSystems Category: READ HTTP method: GET Destination: m3ter Retrieve the valid integration systems. Can be filtered by entityType.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: entityType

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Available Entity Types for System

Function name: m3ter_GetAvailableSystemEntities Category: READ HTTP method: GET Destination: m3ter Retrieve the valid entity types for provided system.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`systemName`	systemName	LookupParameter	Yes	The system to retrieve the configuration for.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Synthetic functions

Native Functions

Retrieve IntegrationConfig

Parameters

Exits

Retrieve Available Auth Config for System and Entity Type

Parameters

Exits

List All IntegrationConfigs

Parameters

Exits

Create IntegrationConfig

Parameters

Exits

Enable IntegrationConfig

Parameters

Exits

Retrieve IntegrationConfig for UUID

Parameters

Exits

Update IntegrationConfig

Parameters

Exits

Delete IntegrationConfig

Parameters

Exits

Get ConfigOption Values

Parameters

Exits

Retrieve Available Configurations

Parameters

Exits

Retrieve Available Integration Systems

Parameters

Exits

Retrieve Available Entity Types for System

Parameters

Exits

​Retrieve IntegrationConfig

​Parameters

​Exits

​Retrieve Available Auth Config for System and Entity Type

​Parameters

​Exits

​List All IntegrationConfigs

​Parameters

​Exits

​Create IntegrationConfig

​Parameters

​Exits

​Enable IntegrationConfig

​Parameters

​Exits

​Retrieve IntegrationConfig for UUID

​Parameters

​Exits

​Update IntegrationConfig

​Parameters

​Exits

​Delete IntegrationConfig

​Parameters

​Exits

​Get ConfigOption Values

​Parameters

​Exits

​Retrieve Available Configurations

​Parameters

​Exits

​Retrieve Available Integration Systems

​Parameters

​Exits

​Retrieve Available Entity Types for System

​Parameters

​Exits

Retrieve IntegrationConfig

Parameters

Exits

Retrieve Available Auth Config for System and Entity Type

Parameters

Exits

List All IntegrationConfigs

Parameters

Exits

Create IntegrationConfig

Parameters

Exits

Enable IntegrationConfig

Parameters

Exits

Retrieve IntegrationConfig for UUID

Parameters

Exits

Update IntegrationConfig

Parameters

Exits

Delete IntegrationConfig

Parameters

Exits

Get ConfigOption Values

Parameters

Exits

Retrieve Available Configurations

Parameters

Exits

Retrieve Available Integration Systems

Parameters

Exits

Retrieve Available Entity Types for System

Parameters

Exits