Live Event Status Reporting

Major events (e.g., creating, starting, and stopping a live event) are tracked for each live event. Our service can report these events as JSON data to a web server through HTTP POST requests. Your web server may then log this data and perform custom actions in response to specific types of events.

Post a Live Event's Status Information to Your Web Server

1. Navigate to the Live Events page.

   • From the main menu, navigate to Settings > Live Events.

2. Under the Event Callback URL section, type the URL to which HTTP POST requests will be submitted.

3. Optional: Choose how you will authenticate requests posted to your web server under the Webhook Secret Token section.

   • No Authentication: Verify that None is selected.

   • Token or Signature Authentication: Perform the following steps:

     • Token Authentication:
       • Select X-Edg-Auth-Token.
       • This mode ensures that each live event status request sent from our service to your web server includes an X-Edg-Auth-Token header set to your secret key.
     • Signature Authentication:
       • Select X-Edg-Signature-256.
       • This mode ensures that each live event status request sent from our service to your web server includes an X-Edg-Signature-256 header set to an encrypted value that represents the request's payload.

   • Click Generate Secret.

   • Click Copy.

   • Store your secret key in a secure location.

   • Access to a secret key is limited to when it is generated. If you lose your secret key, you will need to generate a new one and update your server-side authentication script to reference it.

   • Click Ok.

4. Click Test to submit a test request to your web server. Verify that your web server received the request.

5. Click Save.

Authentication

Verify that a request came from our service through either of the following authentication methods:

• Token: This mode requires our service to include the X-Edg-Auth-Token header with each request it sends to your web server. This header is set to your secret key. You will need to implement a server-side script that compares your secret key to the X-Edg-Auth-Token header.

  Sample validation function

  Python

  SECRET = '1234567890abcdefghijklmnop' # Replace with your secret key.
  ...
  
      def validate_authentication_token(self, content, callback):
          header_sig = self.headers.get(TOKEN_TYPE_AUTH_TOKEN)
          if SECRET == header_sig:
              callback(content, TOKEN_TYPE_AUTH_TOKEN)

• Signature: Recommended. This mode requires our service to include the X-Edg-Signature-256 header with each request it sends to your web server. This header is set to a signature that is calculated by encrypting the request's payload using a hash-based message authentication code (HMAC-SHA256) and your secret key. You will need to implement a server-side script that calculates this signature and compares it to the X-Edg-Signature-256 header.

  Sample validation function

  Python

  SECRET = '1234567890abcdefghijklmnop' # Replace with your secret key.
  ...
      def validate_signature_256(self, content, callback):
          msg = b64encode(zlib.compress(content.encode('utf8'), 9)).strip()
          sig = hmac.new(SECRET.encode('utf-8'), msg, hashlib.sha256).hexdigest()
          header_sig = self.headers.get(TOKEN_TYPE_SIGNATURE_256)
          if sig == header_sig:
              callback(content, TOKEN_TYPE_SIGNATURE_256)

Below is sample code that instantiates a sample web server and contains functions through which you authenticate a token or a signature:

Request Body

The HTTP POST request body will contain the following properties:

State

Live event states are defined below.

Events

Events are defined below.

Sample Request Body

Updating a live event configuration will trigger Live Event Status Reporting. A sample request body for this type of event is provided below.

{
    "username": "[email protected]",
    "user_id": "abcdefghijklmnopqrstuvwxyz123456",
    "external_id": "",
    "event_id": "1d6f7eb5fe474312947e73ccc1c57e32",
    "timestamp": 1572293065429,
    "event_desc": "My Live Event",
    "state": "pre",
    "testing_complete": null,
    "testing_start": null,
    "event": "Event Updated",
    "metadata": {
        "key2": "value2",
        "key1": "value1"
    }
}