Retrieve

GET 
/workstations/:workstation_id/webhooks/:webhook_id

Retrieve a specific webhook for a workstation.

Request

Path Parameters

workstation_id uidrequired

The UID associated to a Workstation. Learn more

webhook_id uuidrequired

Responses

200

Successfully retrieved the webhook.

application/json

Schema

Schema

id uuidrequired

The UUID associated with a webhook.

url urirequired

The URL to which webhook events will be sent.

events WebhookEvent (string)[]required

Possible values: [workstation.created, workstation.released, recording.started, recording.stopped, recording.file_added, transcript.completed, meeting.started, meeting.ended, browser.tab_opened, browser.tab_closed]

active booleanrequired

Whether the webhook is currently active.

created_at date-timerequired

The time the webhook was created.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "url": "string",
  "events": [
    "workstation.created"
  ],
  "active": true,
  "created_at": "2024-07-29T15:51:28.071Z"
}

400

Invalid Request Format - check API documentation for proper syntax.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

401

Unauthorized - missing or invalid API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

422

Unprocessable Entity - cannot find requested asset associated with your API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

429

Too Many Requests - you have exceeded the rate limit for your account. Please wait before making additional requests.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

500

Internal Server Error - please retry your request.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Loading...