GetConnectorInfo

The GetConnectorInfo action retrieves information about a specific connector. It returns a connector object containing configuration details such as settings, provider, and other connector-level fields. If no matching connector is found, it returns an empty/falsy value.

GetConnectorInfo(
    integrationIdn: str,
    connectorIdn: str,
)

Parameters

ParameterTypeDescription
integrationIdnstrThe integration identifier (e.g., "newo_voice", "twilio_messenger", "newo_chat").
connectorIdnstrThe connector identifier (e.g., "newo_voice_connector", "sms_connector").

Returns object with properties

ParameterTypeDescription
integrationIdnstrThe integration identifier of the connector.
connectorIdnstrThe unique identifier of the connector.
titlestrThe display title of the connector.
statusLiteral["running", "stopped"] | NoneThe current status of the connector, or None.
settingsdict[str, str]A dictionary of settings for the connector.

Example 1 (Get Specific Field)

{% set connector = GetConnectorInfo(integrationIdn="newo_voice", connectorIdn="newo_voice_connector") %}

{{ SendMessage(message=connector.integrationIdn) }}

The above code snippet retrieves the integrationIdn field from the Newo Voice connector.

Example 2 (Get Full Connector Object)

{% set connector = GetConnectorInfo(integrationIdn="newo_chat", connectorIdn="newo_chat") %}

{{SendMessage(message=connector.settings.channel)}}

The above code snippet retrieves the full connector info object and accesses the channel setting.

Example 3 (Check if Connector Exists)

{% if GetConnectorInfo(integrationIdn="twilio_messenger", connectorIdn="sms_connector") %}
    {{SendMessage(message="SMS connector exists.")}}
{% else %}
    {{SendMessage(message="SMS connector not found.")}}
{% endif %}

The above code snippet checks whether a specific connector exists before proceeding.