Page optimized for desktop experience. Please use a desktop browser for best compatibility.

Manage Webcast Q&A

The Q&A module in Rev is used to allow attendees the ability to ask questions during a Webcast. This set of endpoints adds a question, answers a question, and retrieves a Q&A report from an existing Webcast.

Add Question to a Webcast

Adds a question to a specified Webcast.

POST
/api/v2/scheduled-events/{eventId}/questions

Path Parameters

Name Type Description
eventId string Webcast Id to add the question to

Request Parameters

Name Type Description Required
question model/body Question to add to the Webcast Yes
runNumber query Currently running runNumber of the referred event. Default to Main Event run number(0). Should be passed for pre-production. Yes

Question Model Schema

Name Type Description Required
QuestionText string Adds the question text  
ExternalId string External questionId if any are in external system.  Default is blank.  
AskedBy {} userEntity { }

The user that asks the question.  Defaults to the authenticated API user. If specified, the user must have at least view permission on the Webcast (Attendee, Account Admin, Moderator, or Host). Includes object fields:

  • Id – string
  • Username – string
  • Email – string
  
IsAnonymous boolean When true, question is set to anonymous.  Default is false.  
WhenAsked date Timestamp when the question was asked  

Example Request

{
  "QuestionText": "string",
  "ExternalId": "string",
  "AskedBy": {
    "Id": "string",
    "Username": "string",
    "Email": "string"
  },
  "IsAnonymous": true,
  "WhenAsked": "2020-08-10T17:46:10.015Z"
}

Example Response

{
  "questionId": "string"
}

Response Codes

Code Description
400 Bad Request
401 Unauthorized Error

Add Answer to a Webcast Question

Adds an answer to a specified Webcast’s question.

PUT
/api/v2/scheduled-events/{eventId}/questions/{questionId}/answer

Path Parameters

Name Type Description
eventId string GUID corresponding to the referred event.
questionId string GUID corresponding to the referred Webcast question.

Request Parameters

Name Type Description Required
answer model/body Answer to add to the Webcast Yes
runNumber query Currently running runNumber of the referred event. Default to Main Event run number(0). Should be passed for pre-production. Yes

Answer Model Schema

Name Type Description Required
AnswerText string Adds the answer text  
CloseReason string

The reason the question is closed. Values include:

  • Declined
  • FollowUp
  • Answered
  • RepliedDirectly
  
AnsweredBy {} userEntity { }

The user that answers the question.  Defaults to authenticated API user. The user must be an Account Admin, Moderator, or Host. Includes object fields:

  • Id – string
  • Username – string
  • Email – string
  
IsPublic boolean Defaults to true and specifies if the answer is private or public.  
WhenAsked date Timestamp when the question is answered.  

Example Request

{
  "AnswerText": "string",
  "CloseReason": "Declined",
  "AnsweredBy": {
    "Id": "string",
    "Username": "string",
    "Email": "string"
  },
  "IsPublic": true,
  "WhenAnswered": "2020-08-10T17:46:10.016Z"
}

Example Response

{
  "whenAsked": "2020-08-10T17:46:10.203Z",
  "question": "string",
  "askedBy": "string",
  "repliedBy": "string",
  "lastAction": "string",
  "reply": "string",
  "isPublic": true
}

Response Codes

Code Description
400 Bad Request
401 Unauthorized Error

Retrieves a Q&A Report

Retrieves a Q&A report for a specified Webcast.

GET
/api/v2/scheduled-events/{eventId}/questions

Path Parameters

Name Type Description
eventId string Webcast Id to to retrieve a Q&A report for

Request Parameters

Name Type Description Required
runNumber query Currently running runNumber of the referred event. Default to Main Event run number(0). Should be passed for pre-production. Yes

Example Response

{
  "whenAsked": "2020-08-10T17:46:10.198Z",
  "question": "string",
  "askedBy": "string",
  "repliedBy": "string",
  "lastAction": "string",
  "reply": "string",
  "isPublic": true
}

Response Codes

Code Description
401 Unauthorized Error
500 Internal Server Error
Add Question

Add Question to a Webcast

Adds a question to a specified Webcast.

POST
/api/v2/scheduled-events/{eventId}/questions

Path Parameters

Name Type Description
eventId string Webcast Id to add the question to

Request Parameters

Name Type Description Required
question model/body Question to add to the Webcast Yes
runNumber query Currently running runNumber of the referred event. Default to Main Event run number(0). Should be passed for pre-production. Yes

Question Model Schema

Name Type Description Required
QuestionText string Adds the question text  
ExternalId string External questionId if any are in external system.  Default is blank.  
AskedBy {} userEntity { }

The user that asks the question.  Defaults to the authenticated API user. If specified, the user must have at least view permission on the Webcast (Attendee, Account Admin, Moderator, or Host). Includes object fields:

  • Id – string
  • Username – string
  • Email – string
  
IsAnonymous boolean When true, question is set to anonymous.  Default is false.  
WhenAsked date Timestamp when the question was asked  

Example Request

{
  "QuestionText": "string",
  "ExternalId": "string",
  "AskedBy": {
    "Id": "string",
    "Username": "string",
    "Email": "string"
  },
  "IsAnonymous": true,
  "WhenAsked": "2020-08-10T17:46:10.015Z"
}

Example Response

{
  "questionId": "string"
}

Response Codes

Code Description
400 Bad Request
401 Unauthorized Error
Answer Question

Add Answer to a Webcast Question

Adds an answer to a specified Webcast’s question.

PUT
/api/v2/scheduled-events/{eventId}/questions/{questionId}/answer

Path Parameters

Name Type Description
eventId string GUID corresponding to the referred event.
questionId string GUID corresponding to the referred Webcast question.

Request Parameters

Name Type Description Required
answer model/body Answer to add to the Webcast Yes
runNumber query Currently running runNumber of the referred event. Default to Main Event run number(0). Should be passed for pre-production. Yes

Answer Model Schema

Name Type Description Required
AnswerText string Adds the answer text  
CloseReason string

The reason the question is closed. Values include:

  • Declined
  • FollowUp
  • Answered
  • RepliedDirectly
  
AnsweredBy {} userEntity { }

The user that answers the question.  Defaults to authenticated API user. The user must be an Account Admin, Moderator, or Host. Includes object fields:

  • Id – string
  • Username – string
  • Email – string
  
IsPublic boolean Defaults to true and specifies if the answer is private or public.  
WhenAsked date Timestamp when the question is answered.  

Example Request

{
  "AnswerText": "string",
  "CloseReason": "Declined",
  "AnsweredBy": {
    "Id": "string",
    "Username": "string",
    "Email": "string"
  },
  "IsPublic": true,
  "WhenAnswered": "2020-08-10T17:46:10.016Z"
}

Example Response

{
  "whenAsked": "2020-08-10T17:46:10.203Z",
  "question": "string",
  "askedBy": "string",
  "repliedBy": "string",
  "lastAction": "string",
  "reply": "string",
  "isPublic": true
}

Response Codes

Code Description
400 Bad Request
401 Unauthorized Error
Q&A Report

Retrieves a Q&A Report

Retrieves a Q&A report for a specified Webcast.

GET
/api/v2/scheduled-events/{eventId}/questions

Path Parameters

Name Type Description
eventId string Webcast Id to to retrieve a Q&A report for

Request Parameters

Name Type Description Required
runNumber query Currently running runNumber of the referred event. Default to Main Event run number(0). Should be passed for pre-production. Yes

Example Response

{
  "whenAsked": "2020-08-10T17:46:10.198Z",
  "question": "string",
  "askedBy": "string",
  "repliedBy": "string",
  "lastAction": "string",
  "reply": "string",
  "isPublic": true
}

Response Codes

Code Description
401 Unauthorized Error
500 Internal Server Error