Skip to main content
Version: /v2

Webhooks List

participant-joined​

  • This webhook is called when new participant join the meeting with following payload.

Example​

{
    "webhookType": "participant-joined",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
        "participantId": "fkd74h",
        "participantName": "John",
    },
}

participant-left​

  • This webhook is called when participant left the meeting with following payload

Example​

{
    "webhookType": "participant-left",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
        "participantId": "fkd74h",
        "participantName": "John",
    },
}

session-started​

  • This webhook is called when new meeting session is successfully started

Example​

{
    "webhookType": "session-started",
    "data": {
        "sessionId": "613731342f27f56e4fc4b6d0",
        "meetingId": "jvsg-8rjn-j304",
        "start": "2022-07-05T15:55:35.047+00:00",
    },
}

session-ended​

  • This webhook is called when all participants lefts and meeting session is closed

Example​

{
    "webhookType": "session-ended",
    "data": {
        "sessionId": "613731342f27f56e4fc4b6d0",
        "meetingId": "jvsg-8rjn-j304",
        "start": "2022-07-05T15:55:35.047+00:00",
        "end": "2022-07-05T15:60:35.047+00:00",
    },
}

recording-started​

  • Recording started webhook will be received when successfully recording is started in meeting

Example​

{
    "webhookType": "recording-started",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
    },
}

recording-stopped​

  • Recording stopped webhook will be received when recording is successfully stopped in meeting.

Example​

{
    "webhookType": "recording-stopped",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
        "filePath" : "/encoded/videos/62d148951a1eb20029fc9b05.mp4",
        "fileUrl" : "https://cdn.videosdk.live/encoded/videos/62d148951a1eb20029fc9b05.mp4",

    },
}

livestream-started​

  • When you use live-streaming in our meeting service you will receive this webhook when livestream is successfully started.

Example​

{
    "webhookType": "livestream-started",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
    },
}

livestream-stopped​

  • When live-stream is stopped in meeting this webhook is fired with following payload

Example​

{
    "webhookType": "livestream-stopped",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
    },
}

hls-started​

  • When you use HTTP live streaming (HLS) in a meeting, this event will be fired when encoding of HLS has started.

Example​

{
    "webhookType": "hls-started",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
        "downstreamUrl": "https://cdn.videosdk.live/meetings-hls/b8a770ef-d713-4a27-9ab7-e5a0b724caaf/index.m3u8"
    },
}

hls-playable​

  • When you start HTTP live streaming (HLS) in a meeting, this event will be fired when HLS is in a playable state. So, now you can embed downstreamUrl in the HLS player.

Example​

{
    "webhookType": "hls-playable",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
        "downstreamUrl": "https://cdn.videosdk.live/meetings-hls/b8a770ef-d713-4a27-9ab7-e5a0b724caaf/index.m3u8"
    },
}

hls-stopped​

  • This event is fired when you stop a http live streaming in meeting it has following payload

Example​

{
    "webhookType": "hls-stopped",
    "data": {
        "meetingId": "jvsg-8rjn-j304",
        "sessionId": "613731342f27f56e4fc4b6d0",
    },
}

Got a Question? Ask us on discord

Was this helpful?