workwaeDocs
Board
Browse the docs

Meeting apps

4 operations

List meeting apps

get/v1/meeting-apps
SDK workwae.meetingApps.list()

Errors

StatusReasonWhen
403plan_module_unavailable
The tenant's plan does not include Zoom and Webex meetings.

It can also answer the errors every operation can answer. Each error's reason is the body's code.

Responses

  • 200OK
    application/json
    MeetingAppList
    • itemsarray of MeetingApp
      Item properties
      • idstring (uuid)
      • kindenum
        One of"zoom_oauth""zoom_s2s""webex_oauth""webex_service_app"
      • serviceenum
        One of"zoom""webex"
      • namestring
      • clientIdstring
      • zoomAccountIdstring or null
      • statusenum or null
        One of"unverified""active""failing"
      • statusDetailstring or null
      • checkedAtstring (date-time) or null
      • scopesarray of string
      • redirectUristring or null
      • createdAtstring (date-time)
    Headers
    • X-Request-IdstringThe request's id: the X-Request-Id you sent when it is 1 to 128 of A-Z a-z 0-9 . _ : -, else one the API generated.
    • RateLimit-LimitintegerRequests the tightest of the plan's per-minute windows (tenant, credential) admits.
    • RateLimit-RemainingintegerRequests that window still admits.
    • RateLimit-ResetintegerSeconds until that window ends.
curl -X GET "https://api.workwae.com/v1/meeting-apps" \
  -H "Authorization: Bearer $WORKWAE_API_KEY"

Register a meeting app

post/v1/meeting-apps
SDK workwae.meetingApps.create()

A sign-in app (zoom_oauth, webex_oauth) is named by meeting connect sessions in place of the platform's; register redirectUri at the service. A server app (zoom_s2s, webex_service_app) starts unverified; test it.

Errors

StatusReasonWhen
403plan_module_unavailable
The tenant's plan does not include Zoom and Webex meetings.
409meeting_app_exists
The tenant already has a server app for the service.

It can also answer the errors every operation can answer. Each error's reason is the body's code.

Parameters

NameInSchema
Idempotency-Keyheader

Makes the request safe to retry: the first answer to the key is kept for 24 hours and answered again to the same request.

string
length 1 to 255

Request body

required
application/json
one of
  1. Option 1object
    • kindconstantrequired
      Value"zoom_oauth"
    • namestringrequired
      length 1 to 100
    • clientIdstringrequired
      length 1 to 200
    • clientSecretstringrequired
      length 1 to 1024
  2. Option 2object
    • kindconstantrequired
      Value"zoom_s2s"
    • namestringrequired
      length 1 to 100
    • accountIdstringrequired
      length 1 to 200
    • clientIdstringrequired
      length 1 to 200
    • clientSecretstringrequired
      length 1 to 1024
  3. Option 3object
    • kindconstantrequired
      Value"webex_oauth"
    • namestringrequired
      length 1 to 100
    • clientIdstringrequired
      length 1 to 200
    • clientSecretstringrequired
      length 1 to 1024
  4. Option 4object
    • kindconstantrequired
      Value"webex_service_app"
    • namestringrequired
      length 1 to 100
    • clientIdstringrequired
      length 1 to 200
    • clientSecretstringrequired
      length 1 to 1024
    • refreshTokenstringrequired
      length 1 to 4096

Responses

  • 201OK
    application/json
    MeetingApp
    • idstring (uuid)
    • kindenum
      One of"zoom_oauth""zoom_s2s""webex_oauth""webex_service_app"
    • serviceenum
      One of"zoom""webex"
    • namestring
    • clientIdstring
    • zoomAccountIdstring or null
    • statusenum or null
      One of"unverified""active""failing"
    • statusDetailstring or null
    • checkedAtstring (date-time) or null
    • scopesarray of string
    • redirectUristring or null
    • createdAtstring (date-time)
    Headers
    • X-Request-IdstringThe request's id: the X-Request-Id you sent when it is 1 to 128 of A-Z a-z 0-9 . _ : -, else one the API generated.
    • RateLimit-LimitintegerRequests the tightest of the plan's per-minute windows (tenant, credential) admits.
    • RateLimit-RemainingintegerRequests that window still admits.
    • RateLimit-ResetintegerSeconds until that window ends.
    • Idempotent-Replayedconstanttrue when this is the kept answer to an earlier request with the same Idempotency-Key.
curl -X POST "https://api.workwae.com/v1/meeting-apps" \
  -H "Authorization: Bearer $WORKWAE_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "kind": "zoom_oauth",
  "name": "string",
  "clientId": "string",
  "clientSecret": "string"
}'

Test a meeting server app

post/v1/meeting-apps/{appId}/test
SDK workwae.meetingApps.test()

Requests a token the way meetings will and, with user, looks that address up as a host; the app becomes active or failing.

Errors

StatusReasonWhen
400not_testable
The app is a sign-in app, which only account connects use.
403plan_module_unavailable
The tenant's plan does not include Zoom and Webex meetings.
404meeting_app_not_found
The app does not exist.

It can also answer the errors every operation can answer. Each error's reason is the body's code.

Parameters

NameInSchema
appIdrequiredpath
string (uuid)
Idempotency-Keyheader

Makes the request safe to retry: the first answer to the key is kept for 24 hours and answered again to the same request.

string
length 1 to 255

Request body

application/json
object
  • userstring (email)
    max length 320

Responses

  • 200OK
    application/json
    MeetingAppTestResult
    • appMeetingApp
      Properties
      • idstring (uuid)
      • kindenum
        One of"zoom_oauth""zoom_s2s""webex_oauth""webex_service_app"
      • serviceenum
        One of"zoom""webex"
      • namestring
      • clientIdstring
      • zoomAccountIdstring or null
      • statusenum or null
        One of"unverified""active""failing"
      • statusDetailstring or null
      • checkedAtstring (date-time) or null
      • scopesarray of string
      • redirectUristring or null
      • createdAtstring (date-time)
    • checksarray of MeetingAppCheck
      Item properties
      • namestring
      • isOkboolean
      • detailstring
    Headers
    • X-Request-IdstringThe request's id: the X-Request-Id you sent when it is 1 to 128 of A-Z a-z 0-9 . _ : -, else one the API generated.
    • RateLimit-LimitintegerRequests the tightest of the plan's per-minute windows (tenant, credential) admits.
    • RateLimit-RemainingintegerRequests that window still admits.
    • RateLimit-ResetintegerSeconds until that window ends.
    • Idempotent-Replayedconstanttrue when this is the kept answer to an earlier request with the same Idempotency-Key.
curl -X POST "https://api.workwae.com/v1/meeting-apps/6f1c2a4e-8b3d-4e5f-9a7b-1c2d3e4f5a6b/test" \
  -H "Authorization: Bearer $WORKWAE_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "user": "[email protected]"
}'

Delete a meeting app

delete/v1/meeting-apps/{appId}
SDK workwae.meetingApps.delete()

Meetings already created stay at the service. Allowed without the meetings module, so a tenant can remove an app it no longer uses.

Errors

StatusReasonWhen
404meeting_app_not_found
The app does not exist.
409meeting_app_in_use
Account connections were issued through the sign-in app.

It can also answer the errors every operation can answer. Each error's reason is the body's code.

Parameters

NameInSchema
appIdrequiredpath
string (uuid)

Responses

  • 204OK

    No body.

    Headers
    • X-Request-IdstringThe request's id: the X-Request-Id you sent when it is 1 to 128 of A-Z a-z 0-9 . _ : -, else one the API generated.
    • RateLimit-LimitintegerRequests the tightest of the plan's per-minute windows (tenant, credential) admits.
    • RateLimit-RemainingintegerRequests that window still admits.
    • RateLimit-ResetintegerSeconds until that window ends.
curl -X DELETE "https://api.workwae.com/v1/meeting-apps/6f1c2a4e-8b3d-4e5f-9a7b-1c2d3e4f5a6b" \
  -H "Authorization: Bearer $WORKWAE_API_KEY"