Webhooks - Getting Started

To access webhook integrations, click on the account menu and navigate to the Integrations page. From there, you can easily create a new webhook by providing a name and URL. The webhook will be triggered when a meeting ends, and Read will send the meeting data to the specified webhook URL. It's that easy! You can even send a test request to test out your integration before your next meeting.

Note that webhook integrations are available on Pro and Enterprise plans.

Steps

1. Navigate to the integrations page

2. Once on the integrations page, click "Add Webhook"

3. Add a webhook name and url

4. Test your webhook

5. Now have a meeting and see the data flow! And as always, if you have any feedback, please don't hesitate to reach out to support@read.ai

Schema

Webhook Trigger and Payload

The webhook is triggered by the meeting_end event. When a meeting ends, Read will send a HTTP POST request with a JSON payload containing the following information:

• session_id: A unique identifier for the meeting session.
• trigger: The event that triggered the webhook, in this case, "meeting_end". Note that Read only supports "meeting_end" currently, but will add additional triggers in the near future.
• title: The title of the meeting.
• start_time: The start time of the meeting in UTC format.
• end_time: The end time of the meeting in UTC format.
• participants: An array of participants in the meeting.
• owner: The meeting owner.
• summary: A summary of the meeting content.
• action_items: An array of action items discussed during the meeting.
• key_questions: An array of key questions raised during the meeting.
• topics: An array of topics covered in the meeting.
• report_url: A URL to view the meeting report in Read's reporting UI.

Example Payload

Here's an example payload, it also happens to be the payload sent in a webhook test request.

{
  "session_id": "SESSIONID",
  "trigger": "meeting_end",
  "title": "Meeting Title",
  "start_time": "2023-01-01T00:00:00Z",
  "end_time": "2023-01-01T01:00:00Z",
  "participants": [
    {
      "name": "Participant One",
      "email": "participantOne@example.com"
    },
    {
      "name": "Participant Two",
      "email": "participantTwo@example.com"
    }
  ],
  "owner": {
    "name": "Participant One",
    "email": "participantOne@example.com"
  },
  "summary": "Meeting summary goes here...",
  "action_items": [
    {
      "text": "Action item one"
    },
    {
      "text": "Action item two"
    }
  ],
  "key_questions": [
    {
      "text": "Key question one?"
    },
    {
      "text": "Key question two?"
    }
  ],
  "topics": [
    {
      "text": "Topic one"
    },
    {
      "text": "Topic two"
    }
  ],
  "report_url": "https://app.read.ai/analytics/meetings/SESSIONID"
}