API reference

Universal arguments

When Tuple executes your trigger, it passes in useful information via environment variables. These take the form TUPLE_TRIGGER_[name]. These arguments vary by trigger; however, there are two universal arguments that are available to every trigger that gets executed:

Argument	Details
`TUPLE_TRIGGER_CURRENT_USER_EMAIL`	Your email
`TUPLE_TRIGGER_CURRENT_USER_FULL_NAME`	Your full name

Events

The complete list of lifecycle events that you can respond to with triggers.

Call initiated

call-initiated Fired when you start an outgoing call to another person via the popover interface.

Argument	Details
`TUPLE_TRIGGER_CALLEE_EMAIL`	The email of the person you’re calling.
`TUPLE_TRIGGER_CALLEE_FULL_NAME`	The full name of the person you’re calling.

Call incoming

call-incoming Fired when another participant calls your machine.

Argument	Details
`TUPLE_TRIGGER_CALLER_EMAIL`	The email of the person calling you.
`TUPLE_TRIGGER_CALLER_FULL_NAME`	The full name of the person calling you.

Call rejected

call-rejected Fired when the person you’re calling rejects your call.

Argument	Details
`TUPLE_TRIGGER_CALLEE_EMAIL`	The email of the person you’re calling.
`TUPLE_TRIGGER_CALLEE_FULL_NAME`	The full name of the person you’re calling.

Call timed out

call-timed-out Fired when your outgoing call times out.

Argument	Details
`TUPLE_TRIGGER_CALLEE_EMAIL`	The email of the person you’re calling.
`TUPLE_TRIGGER_CALLEE_FULL_NAME`	The full name of the person you’re calling.

Call connected

call-connected Fired when your call is fully connected. (Receives no additional arguments)

Call ended

call-ended Fired when your call ends.

Argument	Details
`TUPLE_TRIGGER_CALL_LENGTH`	The duration that you were on the call in seconds.

Call transcription started

call-transcription-started Fired when a call transcription starts. Transcription can be stopped and restarted within a single call, and each recording session fires its own started/complete pair — use TUPLE_TRIGGER_RECORDING_ID to address the exact session that just started rather than guessing from “the most recent call.”

Argument	Details
`TUPLE_TRIGGER_CALL_ID`	The ID of the call this transcription belongs to.
`TUPLE_TRIGGER_RECORDING_ID`	A UUID identifying the specific recording session that just started. Pass to `tuple transcription --recording <uuid>` to read exactly this session.
`TUPLE_TRIGGER_CALL_ARTIFACTS_DIRECTORY`	The filesystem path to the directory containing the call transcription artifacts.

Call transcription complete

call-transcription-complete Fired when a call transcription finishes, either because the call ended or transcription was disabled. Each started/complete pair is scoped to one recording session; use TUPLE_TRIGGER_RECORDING_ID so a summarizer trigger operates on that session only and doesn’t double-summarize a call whose transcription was restarted.

Argument	Details
`TUPLE_TRIGGER_CALL_ID`	The ID of the call this transcription belongs to.
`TUPLE_TRIGGER_RECORDING_ID`	A UUID identifying the specific recording session that just finished. Pass to `tuple transcription --recording <uuid>` to read exactly this session’s transcript.
`TUPLE_TRIGGER_CALL_ARTIFACTS_DIRECTORY`	The filesystem path to the directory containing the call transcription artifacts.

A minimal call-transcription-complete handler that exports just the session that finished:

#!/bin/sh
tuple transcription export ~/Documents/tuple-transcripts \
  --recording "$TUPLE_TRIGGER_RECORDING_ID"

Room joined

room-joined Fired when you or someone else joins one of your team’s rooms.

Argument	Details
`TUPLE_TRIGGER_IS_SELF`	”true” when this is being fired because you joined a room. “false” when it was someone else.
`TUPLE_TRIGGER_ROOM_NAME`	The name of the room being joined.
`TUPLE_TRIGGER_EMAIL`	The email of the person joining the room.
`TUPLE_TRIGGER_FULL_NAME`	The full name of the person joining the room.

Room left

room-left Fired when you or someone else leaves one of your team’s rooms.

Argument	Details
`TUPLE_TRIGGER_IS_SELF`	”true” when this event was fired because you left a room. “false” when someone else did.
`TUPLE_TRIGGER_ROOM_NAME`	The name of the room being left.
`TUPLE_TRIGGER_EMAIL`	The email of the person leaving the room.
`TUPLE_TRIGGER_FULL_NAME`	The full name of the person leaving the room.

screen-share-started Fired when you or someone else starts sharing their screen on a call.

Argument	Details
`TUPLE_TRIGGER_IS_SELF`	”true” when the event was fired because you started sharing your screen. “false” when someone else did.
`TUPLE_TRIGGER_EMAIL`	The email of the person sharing their screen.
`TUPLE_TRIGGER_FULL_NAME`	The full name of the person sharing their screen.

screen-share-ended Fired when you or someone else stops sharing their screen on a call.

Argument	Details
`TUPLE_TRIGGER_IS_SELF`	”true” when you stopped sharing your screen. “false” when someone else did.
`TUPLE_TRIGGER_EMAIL`	The email of the person stopping their screen share.
`TUPLE_TRIGGER_FULL_NAME`	The full name of the person stopping their screen share.

webcam-share-started Fired when you or someone else starts sharing their webcam on a call.

Argument	Details
`TUPLE_TRIGGER_IS_SELF`	”true” when you started sharing your webcam. “false” when someone else did.
`TUPLE_TRIGGER_EMAIL`	The email of the person sharing their webcam.
`TUPLE_TRIGGER_FULL_NAME`	The full name of the person sharing their webcam.

webcam-share-ended Fired when you or someone else stops sharing their webcam on a call.

Argument	Details
`TUPLE_TRIGGER_IS_SELF`	”true” when you stopped sharing your webcam. “false” when someone else did.
`TUPLE_TRIGGER_EMAIL`	The email of the person no longer sharing their webcam.
`TUPLE_TRIGGER_FULL_NAME`	The full name of the person no longer sharing their webcam.

Participant joined

participant-joined Fired whenever someone joins your call, whether it’s a call starting, someone being added, or someone joining the room you’re in.

Argument	Details
`TUPLE_TRIGGER_EMAIL`	The email of the person that joined your call.
`TUPLE_TRIGGER_FULL_NAME`	The full name of the person that joined your call.

Participant left

participant-left Fired whenever someone leaves your call.

Argument	Details
`TUPLE_TRIGGER_EMAIL`	The email of the person that left your call.
`TUPLE_TRIGGER_FULL_NAME`	The full name of the person that left your call.

Getting Started

Pairing with Tuple

Managing Your Account

Team Management

Application Preferences

Tuple CLI

Triggers

Troubleshooting

Universal arguments

Events

Call initiated

Call incoming

Call rejected

Call timed out

Call connected

Call ended

Call transcription started

Call transcription complete

Room joined

Room left

Participant joined

Participant left

​Universal arguments

​Events

​Call initiated

​Call incoming

​Call rejected

​Call timed out

​Call connected

​Call ended

​Call transcription started

​Call transcription complete

​Room joined

​Room left

​Screen share started

​Screen share ended

​Webcam share started

​Webcam share ended

​Participant joined

​Participant left

Universal arguments

Events

Call initiated

Call incoming

Call rejected

Call timed out

Call connected

Call ended

Call transcription started

Call transcription complete

Room joined

Room left

Screen share started

Screen share ended

Webcam share started

Webcam share ended

Participant joined

Participant left