Webhook Type
feed.video.received
Payload Format
type, data and reviewer_email are the only top-level keys. reviewer_email is the email answer lifted out of data.response, and is null when the form did not collect one.
Object Structure
Project Object
Theproject object contains information about the workspace/project where the review was submitted.
Project Fields
logo: URL to the project’s logo imagename: Name of the project/workspacedescription: Description or identifier for the project
Feed Form Object
Thefeed_form object contains information about the review form used to collect the feedback.
Feed Form Fields
id: The form’s public slug, the same identifier that appears in the form’s public URL. This is not theunique_form_idused by the Review Forms API, so it cannot be passed to those endpoints.url: Public URL where the form can be accessedlogo: URL to the form’s page image. Only present when the form has a page image configured, so treat it as optional.name: Name or title of the review form
Response Object
Theresponse object contains the actual review data submitted by the user.
Fields
name: Name of the person who submitted the reviewemail: Email address of the reviewerconsent: Whether the reviewer gave consent to share their informationposition: Position or role of the reviewerorganization_name: Name of the organization of the reviewercontact_number: Phone number of the reviewerphoto: URL to the reviewer’s photocompany_logo: URL to the reviewer’s company logocompany_url: Website URL of the reviewer’s companyother_text: Answer of the custom field added by the Feedspace user in the feed form settingsother_text2: Answer of the second custom field, when the form defines oneother_text3: Answer of the third custom field, when the form defines onetype: How the video was captured ("Video","Screen"or"Upload")comment: The written review text submitted alongside the video,nullwhen none was givenrating: The star rating as a string, e.g."5"or"4.5", andnullwhen the form did not collect a rating
Name, Email or Photo, so match case-insensitively if you need to support older forms.
Note: All fields in this object are customizable. They can be enabled or disabled in the feed form settings. If a field is not enabled in the form settings, it will not be included in the webhook response. type, comment and rating are always present.
Top-Level Fields
Top-Level Field Descriptions
feed_id: Unique identifier for this specific reviewfeed_url: Public URL where the review is accessiblethumbnail_url: URL to the video thumbnail image. When no thumbnail was generated this is an empty string"", notnull.video_url: URL to access the video filevideo_extension: File extension of the video (e.g., mp4)video_size: Size of the video file in bytes, as an integerfavourite: Whether this review is marked as favoritecreated_at: Timestamp when the review was createdupdated_at: Timestamp when the review was last updatedlive_mode: Whether this is a live mode (true) or test mode (false)