Webhooks

How to add a Webhook:
Triggers supported by Sessions:
Data structure for each trigger
1. (SESSION|BOOKING|EVENT)\_(CREATED|STARTED|ENDED), EVENT_PUBLISHED:
2. EVENT_NEW_REGISTRATION:
3. TAKEAWAY_READY:
4. TRANSCRIPT_READY:
How to use Sessions' Webhooks with other apps
Example of use cases for Webhooks
Events:
Bookings:

A webhook is a feature that enables real-time communication between different applications or services. It allows Sessions to automatically send data or notifications to another application when specific events occur. We call such events triggers.

💡

Sessions native Webhooks integration allows you to send data about your event and registered participants to any URL you choose.

The data that is sent through the webhook has the following format:

{

    /**
    The name of the trigger.
    See list bellow.
    */
    trigger,

    /**
    The data associated with the trigger.
    See format bellow.
    */
    data,
}

When more information is required, webhooks can be easily used together with our public API.

How to add a Webhook:

Go to your Profile → Account settings.
Click on Webhooks.
Click on Add a webhook.
Choose the trigger and copy the URL of your choice.
And click on Add webhook.
You can always edit or delete your webhooks.

Triggers supported by Sessions:

👉

SESSION_CREATED: Triggered when a new session is created. It could be useful for preparing the initial setup, informing participants or any other purpose you find relevant.

👉

SESSION_STARTED: Triggered when a session starts. It can be used to notify users that the session has started or to activate any real-time functionality you may have in your application.

👉

SESSION_ENDED: Triggered when a session has ended. This could be used to start data processing.

👉

BOOKING_CREATED: Triggered when a new booking is created This can be useful for scheduling, resource allocation, or sending out notifications.

👉

BOOKING_STARTED: Triggered when a booking starts. It can be used to enable specific functionalities or to notify relevant users.

👉

BOOKING_ENDED: Triggered when a booking ends. It can be used to free up resources, process data or to send out notifications.

👉

EVENT_CREATED: Triggered when a new event is created. It can be used for notification purposes, resource allocation, or any other preparation necessary for the event.

👉

EVENT_STARTED: Triggered when an event starts. It can be used to enable specific functionalities or to notify relevant users.

👉

EVENT_ENDED: Triggered when an event ends. It can be used to start data processing, clean up resources, or to notify users.

👉

EVENT_PUBLISHED: Triggered when an event is published, making it visible to users or attendees. This could be used to send out notifications or announcements.

👉

EVENT_NEW_REGISTRATION: Triggered when a new registration for an event occurs. It can be used to track participant numbers, inform event staff, or notify other attendees.

👉

TRANSCRIPT_READY: Triggered when a session has ended. This can be useful for sending out transcripts to participants or saving the transcript for future reference.

👉

TAKEAWAY_READY: Triggered when a takeaway becomes available, either when a session has ended or a summary is generated. It can be useful for post-session or post-event follow-ups.

Data structure for each trigger

1. (SESSION|BOOKING|EVENT)\_(CREATED|STARTED|ENDED), EVENT_PUBLISHED:

type SessionDataPayload = {
    session: {
        id: string;
        name: string;
        description: string | null;

        // True for Instant Sessions, false for Planned Sessions
        quickSession: boolean;

        // Defined only if the session is a room, null otherwise
        room: {
            id: string;
            slug: string | null;
        } | null;

        // Defined only for bookings, null otherwise
        booking: {
            id: string;
            name: string;
            participantName: string;
            participantEmail: string;
            guests: string[];
        } | null;

        // Defined only for events, null otherwise
        event: {
            id: string;
            slug: string;
        } | null;

        participants: Array<{
            id: string;
            isOwner: boolean;

            // Defined only for guests, null otherwise
            guest: {
                id: string;
                email: string | null;
                lastName: string | null;
                firstName: string;
            } | null;

            // Defined only for registered users, null otherwise
            user: {
                id: string;
                email: string;
                lastName: string;
                firstName: string;
            } | null;
        }>;
    };
};

2. EVENT_NEW_REGISTRATION:

type EventNewRegistrationData = {
    sessionId?: string;
    eventId: string;
    registeredParticipant: {
        id: string;
        email: string;
        firstName: string;
        lastName?: string;
        form: Array<{question: string; answer?: string}>;
    };
}

3. TAKEAWAY_READY:

type TakewaysReadyData = {
    session: {
        id: string;
        takeawaysText: string;
        takeawaysRaw: JSON;
    }
}

4. TRANSCRIPT_READY:

type TranscriptReadyData = {
    session: {
        id: string;
        transcripts: Array<{
            content: Array<{
                text: string;
                language: string;
            }>;
            participantId: string;
            sourceLanguage: string;
            sourceTimestamp: Date;
        }>;
    };
}

How to use Sessions' Webhooks with other apps

An HTTPS server is essential for setting up a webhook to relay data from Sessions to your server.

The endpoint from this server should use the HTTPS protocol for security reasons and able to handle JSON payloads, specified in this documentation. Thus, you will need a publicly accessible URL that uses HTTPS to set up Webhooks. This HTTPS server can be your own or from other apps like Zapier, RequestBin etc.

Example of use cases for Webhooks

Events:

For every participant that registers to your event, you can set up a webhook that is triggered for EVENT_NEW_REGISTRATION and send them with external apps additional emails with different materials for your event.
For the same webhook trigger, EVENT_NEW_REGISTRATION, you can filter the form answers from registration and based on certain response, to use external apps to send them additional emails with different materials or marketing info.
For EVENT_PUBLISHED webhook trigger, you can use it with an external app, to send emails to a group of contacts and inform them that you've published an event and they should check it out.
For EVENT_ENDED webhook trigger, you can set with an external app to sent out survey to get feedback about the event from participants

Bookings:

For BOOKING_CREATED webhook trigger, you can set with an external app to send out notifications to your team.
For BOOKING_ENDED webhook trigger, you can set with an external app to sent out survey to get feedback about the meeting from participants