SendMessage

Send a message to users/actors.

SendMessage(
    message: str,
    actorIds: List[str],
    useFilter: bool = false,
    **arguments: str
)

Where:

  • message: The message string you want to send.
  • actorIds: List of actor IDs to whom the message needs to be sent.
  • useFilter: A boolean value that switches off filtering capabilities to show/hide certain placeholder text.
  • **arguments: Arbitrary arguments sent along with the message.

Example 1

Send a "Test message" to the current user.

{{SendMessage(message="Test message", argument1="value", testValue="argument value 2")}}

Where:

  • argument1 and testValue are the arguments that will be sent to the user along with the message.

Example 2

Send a "Test message" to the user with the email: [email protected]

{{SendMessage(message="Test message", actorIds=GetActors(externalId="[email protected]", integrationIdn="email", connectorIdn="gmail"))}}

Example 3

Send a "Test message" to all users who have an actor with integrationIdn="sandbox" and connectorIdn="mysandbox."

{{SendMessage(message="Test message", actorIds=GetActors(integrationIdn="sandbox", connectorIdn="mysandbox"))}}

Example 4

Send a "Test message" to the current user on the connector with integrationIdn="sandbox" and connectorIdn="mysandbox."

{{SendMessage(message="Test message", actorIds=GetActors(personaId=GetUser(field="id"), integrationIdn="sandbox", connectorIdn="mysandbox"))}}

Example 5

Set up any connector that takes filtered messages (e.g., Telegram or Vapi). Messages you see in the Sandbox chat are source messages, which means you will not see filtered messages. The filtered message within [[[text]]] is removed when setting useFilter to true.

{{SendMessage(message="Your code is: [[[beef]]]!")}}
{{SendMessage(message="Your code is: [[[beef]]]!", useFilter=True)}}
Your code is: [[[beef]]]!
Your code is: !