Whereby
Create and manage Whereby Embedded meeting rooms, retrieve room-session usage, and list recording metadata.
Connectors
Choose the connector that matches your authentication method. The options below use the names shown in StackAI.
Whereby
Organization API key
Whereby
Connect a Whereby Embedded organization API key to create and manage meeting rooms, view session usage, and list recording metadata.
Set up in Whereby
Prepare the Whereby account or service that the workflow will access. Grant access to the required resources and operations.
Organization API key: Create an organization API key in your Whereby Embedded dashboard under Configure > API > API keys. Whereby shows the key only once.
Set up in StackAI
Open Settings → Connections, add a connection, and select Whereby.
Enter the credentials and connection details in the fields below.
Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.
Connection fields
Organization API key
Yes
Create an organization API key in your Whereby Embedded dashboard under Configure > API > API keys. Whereby shows the key only once. Provider instructions.
Verify the connection
Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.
If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.
Use an action
Add the required Whereby action to the workflow.
Select a connection when the action requests one.
Complete the required fields. Use the reference picker when a value comes from another workflow step.
Run the workflow and inspect the action’s output. Check the result before using it in a later step.
Actions
Create Meeting
Create a temporary Whereby video room and return guest and host links.
Inputs
Room expiration time
datetime
Yes
The room expiration reference time. Whereby deactivates the room one hour later; it does not end an ongoing call or eject participants.
Room size
select (string)
No
Choose the room capacity needed for the meeting. Available values: Normal (up to 4 participants), Group (more than 4 participants). Default: normal.
Start locked
boolean
No
Require a host to admit participants when the room opens. Default: false.
Room name prefix
string
No
Add a recognizable lowercase prefix to the generated room name.
Room name format
select (string)
No
Choose the format of the generated part of the room name. Available values: UUID, Human short. Default: uuid.
Outputs
Meeting ID
string
The identifier for getting or deleting this meeting.
Room name
string
The generated room name used by insights and recording filters.
Guest URL
string
The link participants use to join the meeting.
Host URL
secret
The sensitive link that grants host controls in the meeting.
Start time
datetime
The UTC time from which the room is available.
Room expiration time
datetime
The UTC expiration reference time stored by Whereby. The room deactivates one hour later without ending an ongoing call or ejecting participants.
Delete Meeting
End a Whereby meeting immediately and prevent anyone from rejoining.
Inputs
Meeting
select (string)
Yes
Select the meeting to end and delete. Options load from the selected connection.
Outputs
Meeting ID
string
The identifier of the meeting deletion that completed.
Deleted
boolean
Confirms that the meeting can no longer be used.
Get Meeting
Retrieve the current details and join links for one Whereby meeting.
Inputs
Meeting
select (string)
Yes
Select the meeting whose details you need. Options load from the selected connection.
Include host URL
boolean
No
Return the sensitive link that grants host controls. Default: false.
Include viewer URL
boolean
No
Return a view-only link when the room supports viewer mode. Default: false.
Outputs
Meeting ID
string
The meeting identifier.
Room name
string
The room name used by insights and recording filters.
Guest URL
string
The link participants use to join the meeting.
Host URL
secret
The requested sensitive link that grants host controls.
Viewer URL
secret
The requested sensitive viewer link that grants room access without knocking, even when the room is locked.
Start time
datetime
The UTC time from which the room is available.
Room expiration time
datetime
The UTC expiration reference time stored by Whereby. The room deactivates one hour later without ending an ongoing call or ejecting participants.
Get Room Sessions
Report participant, recording, and streaming usage for a room's sessions.
Inputs
Room
select (string)
Yes
Select or enter the room whose usage you want to report. Options load from the selected connection.
Session ID
string
No
Limit the report to one known room session.
Maximum results
integer
No
Stop after this many session summaries (maximum 2000). Minimum: 1. Maximum: 2000. Default: 100.
Continue from cursor
string
No
Continue a previous session listing from its returned cursor.
Outputs
Sessions
object_array
The room's participant, recording, and streaming usage summaries.
Cursor
string
Pass this cursor to continue when more sessions are available.
List Recordings
List Whereby recording metadata for transcription or summarization workflows.
Inputs
Room name
select (string)
No
Only return recordings from this room. Options load from the selected connection.
Sort by
select (string)
No
Choose the recording field used to order results. Available values: Room name, Start time, Duration, Size (MB). Default: startDate.
Sort direction
select (string)
No
Show lower or higher sort values first. Available values: Ascending, Descending. Default: desc.
Maximum results
integer
No
Stop after this many recording records (maximum 2000). Minimum: 1. Maximum: 2000. Default: 100.
Continue from cursor
string
No
Continue a previous recording listing from its returned cursor.
Outputs
Recordings
object_array
Recording metadata returned by Whereby.
Cursor
string
Cursor to continue listing when more recordings remain.
Important behavior
Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.
The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.
Last updated
Was this helpful?

