Skip to main content

Webhook Payload Details

Learn how to configure webhooks to include question responses and MP3 file links in the data you receive.

Vatsal Shah avatar
Written by Vatsal Shah
Updated over 2 weeks ago

Webhook Payload Details

Overview

This feature ensures you receive all the important information from your media, including question responses and direct links to your audio files.

By understanding what's included in the webhook payload, you can easily integrate this data into your workflows and leverage it for further analysis or distribution.

How It Works

The webhook payload contains core media metadata by default. To ensure you receive question responses (from Recorder) and direct MP3 links, the payload includes specific fields.

Payload Details

The webhook payload provides the following key information:

  • Questions/Answers: These are found within the metaData or insight object in the payload. The exact location depends on the event type, such as media.created or media.processed.

  • MP3 Link: A direct link to your MP3 file is included in either the mediaUrl or sourceUrl field. Please note that for security reasons, some of these URLs might be temporary signed URLs.

Configuration

There is no specific setting to "enable" this feature; it is a standard part of the full payload. If you find that you are missing data, please follow these steps:

  1. Ensure you are listening to the media.processed event. This event provides the most complete insights, including answers and final processed audio URLs.

  2. Check the metaData field within the JSON response for the information you need.

Getting Started

To access and manage your webhook settings, go to Settings β†’ Webhooks in your dashboard.

Next Steps

Ready to ensure you're receiving all the necessary webhook data?

  • Review your webhook configuration to confirm you are listening to the correct events.

  • Check your payload for the metaData, insight, mediaUrl, or sourceUrl fields.

  • Contact support if you continue to experience issues or have further questions.

Did this answer your question?