Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.feedspace.io/llms.txt

Use this file to discover all available pages before exploring further.

This webhook is triggered whenever a new audio review is received in your Feedspace account.

​
Webhook Type

feed.audio.received

​
Payload Format

{
  "type": "feed.audio.received",
  "data": {
    "user": {
      "id": "USER_ID",
      "name": "USER_NAME",
      "email": "USER_EMAIL",
      "notification": {
        "received_text_feed": true,
        "received_audio_feed": true,
        "received_video_feed": true
      },
      "custom_domain": {
        "domain": "CUSTOM_DOMAIN",
        "status": true,
        "favicon": "FAVICON_URL"
      }
    },
    "project": {
      "logo": "LOGO_URL",
      "name": "PROJECT_NAME",
      "description": "PROJECT_DESCRIPTION"
    },
    "feed_form": {
      "id": "FORM_ID",
      "url": "FORM_URL",
      "logo": "FORM_LOGO_URL",
      "name": "FORM_NAME"
    },
    "feed_id": "FEED_ID",
    "feed_url": "FEED_URL",
    "audio_url": "AUDIO_FILE_URL",
    "audio_size": "AUDIO_SIZE_IN_BYTES",
    "audio_extension": "AUDIO_FILE_EXTENSION",
    "response": {
      "Name": "RESPONDER_NAME",
      "Email": "RESPONDER_EMAIL",
      "type": "REVIEW_TYPE",
      "consent": true,
      "position": "RESPONDER_POSITION",
      "organization_name": "RESPONDER_ORGANIZATION_NAME"
      "contact_number": "RESPONDER_PHONE_NUMBER",
      "photo": "RESPONDER_PHOTO_URL",
      "other_text": "ANSWER_TO_CUSTOM_FIELD",
    },
    "favourite": false,
    "created_at": "TIMESTAMP",
    "updated_at": "TIMESTAMP",
    "live_mode": true
  }
}

​
Object Structure

​
User Object

The user object contains information about the Feedspace user who owns the workspace. 
{
  "id": "USER_ID",
  "name": "USER_NAME",
  "email": "USER_EMAIL",
  "notification": {
    "received_text_feed": true,
    "received_audio_feed": true,
    "received_video_feed": true
  },
  "custom_domain": {
    "domain": "CUSTOM_DOMAIN",
    "status": true,
    "favicon": "FAVICON_URL"
  }
}

​
User Fields

  • id: Unique identifier for the Feedspace user account
  • name: Display name of the Feedspace user
  • email: Email address associated with the Feedspace account
  • notification: Object containing notification preferences
    • received_text_feed: Whether user receives notifications for text reviews
    • received_audio_feed: Whether user receives notifications for audio reviews
    • received_video_feed: Whether user receives notifications for video reviews
  • custom_domain: Object containing custom domain settings
    • domain: Custom domain URL if configured
    • status: Boolean indicating if custom domain is active
    • favicon: URL to custom domain’s favicon

​
Project Object

The project object contains information about the workspace/project where the review was submitted. 
{
  "logo": "LOGO_URL",
  "name": "PROJECT_NAME",
  "description": "PROJECT_DESCRIPTION"
}

​
Project Fields

  • logo: URL to the project’s logo image
  • name: Name of the project/workspace
  • description: Description or identifier for the project

​
Feed Form Object

The feed_form object contains information about the review form used to collect the feedback. 
{
  "id": "FORM_ID",
  "url": "FORM_URL",
  "logo": "FORM_LOGO_URL",
  "name": "FORM_NAME"
}

​
Feed Form Fields

  • id: Unique identifier for the review form
  • url: Public URL where the form can be accessed
  • logo: URL to the form’s logo image
  • name: Name or title of the review form

​
Response Object

The response object contains the actual review data submitted by the user. 
{
  "Name": "RESPONDER_NAME",
  "Email": "RESPONDER_EMAIL",
  "type": "REVIEW_TYPE",
  "consent": true,
  "position": "RESPONDER_POSITION",
  "organization_name": "RESPONDER_ORGANIZATION_NAME",
  "contact_number": "PHONE_NUMBER",
  "photo": "PHOTO_URL",
  "other_text": "ANSWER_TO_CUSTOM_FIELD",
}

​
Fields

  • Name: Name of the person who submitted the review
  • Email: Email address of the reviewer
  • type: Type of review (e.g., “Audio”, “Upload”)
  • consent: Whether the reviewer gave consent to share their information
  • position: Position or role of the reviewer
  • organization_name: Name of the organization of the reviewer
  • contact_number: Phone number of the reviewer
  • photo: URL to the reviewer’s photo
  • other_text: Answer of the custom field added by the Feedspace user in the feed form settings
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.

​
Top-Level Fields

{
  "feed_id": "FEED_ID",
  "feed_url": "FEED_URL",
  "audio_url": "AUDIO_FILE_URL",
  "audio_size": "AUDIO_SIZE_IN_BYTES",
  "audio_extension": "AUDIO_FILE_EXTENSION",
  "favourite": false,
  "created_at": "TIMESTAMP",
  "updated_at": "TIMESTAMP",
  "live_mode": true
}

​
Top-Level Field Descriptions

  • feed_id: Unique identifier for this specific review
  • feed_url: Public URL where the review is accessible
  • audio_url: URL to access the audio file
  • audio_size: Size of the audio file in bytes
  • audio_extension: File extension of the audio (e.g., mp3)
  • favourite: Whether this review is marked as favorite
  • created_at: Timestamp when the review was created
  • updated_at: Timestamp when the review was last updated
  • live_mode: Whether this is a live mode (true) or test mode (false)