Configuration

Screenleap

You can further configure your API integration from the Developer Account Settings page.

Webhook URL

Specify a callback URL to receive server-side notification of events related to your share sessions. For each event, a single HTTP POST request will be made to the callback URL with related data in JSON format.

We currently support the following event types:

PRESENTER_CONNECT — Sent when the presenter first connects to the Screenleap server.
SHARE_END — Sent when the share session ends.
RECORDING_COMPLETE — Sent when the recording is successfully processed.
RECORDING_ERROR — Sent when there is an error in processing the recording.

Below is an example of the JSON returned for a PRESENTER_CONNECT callback:

{
    "eventType": "PRESENTER_CONNECT",
    "screenShareCode": "123456789",
    "isSecure": true,
    "externalId": "my-meeting-1234",
    "startTime": 1429211907496
}

Below is an example of the JSON data returned for a SHARE_END callback:

{
    "eventType": "SHARE_END",
    "screenShareCode": "123456789",
    "isSecure": true,
    "externalId": "my-meeting-1234",
    "startTime": 1429211907496,
    "endTime": 1429211926154,
    "totalViewers": 3,
    "durationInMinutes": 10,
    "centsPerUserPerMinute": 1
}

There are cases (i.e., computer crash) in which the share session can end without triggering the JavaScript callback. In these instances, a server callback can be a more reliable way to retrieve the share session data.

If you are interested in being notified of share session events from your web page, you should integrate with our JavaScript callbacks instead.

Redirect URLs

Redirect-on-end URL

If specified, the viewers will be redirected to this URL when the share session ends.

Redirect-on-error URL

If specified, the viewers will be redirected to this URL if there is an error loading the share session. If no URL is provided, the default behavior is to display a message letting the viewers know that there was an error.

Continue to FAQ »