Embedded API
Number of APIs: 23
Hello friend! 👋
This collection lets you quickly create a Whereby room using our API.
Here's what you need to do:
- Make sure you have your Whereby API key available. If you don't have a key, log in to your Whereby Embedded account and create one.
- Open the
Variables
section of this collection and paste your Whereby API key into theCurrent value
field for the MYWHEREBYAPI_KEY variable. - Select one of the POST requests for creating a room and click
Send
If successful, you should get a response back (Status 201 Created) including the meetingId
and roomUrl
for the room you just created. The room will be available immediately, and will be automatically deleted after two weeks. You can change the room lifespan by modifying the endDate
in the request body, along with some other settings.
You can also use the GET request to fetch information for a meeting or the DELETE request to delete it. You can target a specific room by including the meetingId at the end of the request URL, either by updating the MEETINGID variable or just replacing it with an actual meetingId direcly in the URL.
For more details on how to use our API, head over to our API reference
Learn more about embedding Whereby rooms in our Embedded developer guide
-
/meetings - List rooms GET https://api.whereby.dev/v1/meetings
-
/insights - Get room insights GET https://api.whereby.dev/v1/insights/rooms
-
/insights - Get room session insights GET https://api.whereby.dev/v1/insights/room-sessions?roomName={{ROOMNAME}}
-
/insights - Get session participants insights GET https://api.whereby.dev/v1/insights/participants?roomSessionId={{ROOMSESSIONID}}
-
/insights - Get session participant details GET https://api.whereby.dev/v1/insights/participant?roomSessionId={{ROOMSESSIONID}}&participantId={{PARTICIPANTID}}
-
/recordings - Get recordings GET https://api.whereby.dev/v1/recordings
-
/recordings - Get specific recording GET https://api.whereby.dev/v1/recordings/{{RECORDINGID}}
-
/recordings - Get recording access link GET https://api.whereby.dev/v1/recordings/{{RECORDINGID}}/access-link
-
/recordings - Delete a recording DELETE https://api.whereby.dev/v1/recordings/{{RECORDINGID}}
-
/recordings - Bulk delete recordings POST https://api.whereby.dev/v1/recordings/bulk-delete