Skip to main content

Integrations | Getting Started with Webhooks

Updated

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 for any meeting that you have at least "viewer" access to, 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 to set up webhooks

1. Navigate to the integrations page

Screen_Shot_2023-05-04_at_1.18.50_PM.png

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

Screen_Shot_2023-05-04_at_1.21.09_PM.png

3. Add a webhook name and url

Screen_Shot_2023-05-04_at_1.20.25_PM.png

4. Test your webhook

Screen_Shot_2023-05-04_at_1.21.14_PM.png

5. Now have a meeting and see the data flow!

Please note that the status will still show as "Pending" until you have a meeting after setting up the webhook. As long as the URL you provided responds successfully to the webhook triggering, the status will then update to "Active".

 

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.
  • transcript: The full meeting transcript, including speaker names and timestamps in Unix time (milliseconds)

Example Payload

Here's an example payload, which should look very similar to 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",
  "chapter_summaries": [
    {
      "title": "Chapter one",
      "description": "First chapter description goes here...",
      "topics": [
        {
          "text": "Topic one"
        }
      ]
    },
    {
      "title": "Chapter two",
      "description": "Second chapter description goes here...",
      "topics": [
        {
          "text": "Topic two"
        }
      ]
    }
  ],
  "transcript": {
    "speakers": [
      {
        "name": "Speaker 1"
      },
      {
        "name": "Speaker 2"
      },
    ],
    "speaker_blocks": [
      {
        "start_time": "1719514000000",
        "end_time": "1719514001000",
        "speaker": {
          "name": "Speaker 1"
        },
        "words": "Good morning everyone!"
      },
      {
        "start_time": "1719514002000",
        "end_time": "1719514003000",
        "speaker": {
          "name": "Speaker 2"
        },
        "words": "Hi!"
      }
    ]
  }
}

 

FAQs

Why does my webhook show as "stopped"?

If Read tries and fails to send data to a webhook, after 25 consecutive failures our system will automatically disable the webhook and mark it as "stopped". If this happens to you, please confirm that the endpoint you configured for the webhook is still functioning properly and able to accept data from Read. You may also need to delete and create a new webhook from Read in order to re-enable it.

Can I manually push previous meeting reports to my webhook?

Currently no, webhooks will only fire once per meeting, when the report is first generated and made available in your account.

Related articles

Related articles