API reference
When Tuple executes your trigger, it passes in useful information via environment variables. These take the form TUPLE_TRIGGER_[name]
.
These argument vary by trigger, however, there are two universal arguments that are available to every trigger that gets executed:
Arguments | Details |
---|---|
TUPLE_TRIGGER_CURRENT_USER_EMAIL | Your email |
TUPLE_TRIGGER_CURRENT_USER_FULL_NAME | Your full name |
The complete list of lifecycle events that you can respond to with triggers.
call-initiated
Fired when you start an outgoing call to another person via the popover interface.
Arguments | 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
Fired when you another participant calls your machine.
Arguments | 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
Fired when the person you’re calling rejects your call.
Arguments | Details |
---|---|
TUPLE_TRIGGER_CALLEE_EMAIL | The email of the person you’re calling. |
TUPLE_TRIGGER_CALLEE_FULL_NAME | The email of the person you’re calling. |
call-timed-out
Fired when your outgoing call times out.
Arguments | Details |
---|---|
TUPLE_TRIGGER_CALLEE_EMAIL | The email of the person you’re calling. |
TUPLE_TRIGGER_CALLEE_FULL_NAME | The email of the person you’re calling. |
call-connected
Fired when your call is fully connected.
(Receives no additional arguments)
call-ended
Fired when your call ends.
Name | Details |
---|---|
TUPLE_TRIGGER_CALL_LENGTH | The duration that you were on the call in seconds. |
room-joined
Fired when you or someone else joins one of your team’s rooms.
Arguments | 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
Fired when you or someone else leaves one of your team’s rooms.
Arguments | 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.
Arguments | 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.
Arguments | 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.
Arguments | Details |
---|---|
TUPLE_TRIGGER_IS_SELF | “true” when you started 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 stop sharing their webcam on a call.
Arguments | 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
Fired whenever someone joins your call, whether it’s a call starting, someone being added, or someone joining the room you’re in.
Arguments | 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
Fired whenever someone leaves your call.
Arguments | 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. |