Introduction

This document describes the scope and payload for the subscriber of the virtual-stage-event-started event through web hooks.

Scope

The event is subscribed at the company level. The subscription includes all events owned by the company and its chid companies. The event is invoked when the host clicks on the "Go Live" on the virtual stage.

Payload

Request

Body

A HTTP post request is made to the endpoint registered as the web hook for the virtual stage event started event with the following payload in its body:

{
  "eventType": "virtual-stage-event-started",
  "webHookInvocationId": "unique web hook invocation id",
  "correlationId": "unique id for this virtual stage event started event"
  "timestamp": "2022-01-07T10:05:24.000Z", 
  "details": {   
     "companyId": "Unique id of the company owning the event",
     "companyName": "Name of the company",
     "eventId": "Unique id of the virtual stage event",
     "eventName": "Name of the event",
  }   
}

Headers

The following headers will be included in the headers for the request

Header Key	Value	Description
x-introvoke-web-hook-auth	Authentication key	The key to validate the authenticity of request
user-agent	`introvoke-web-hook`	Static value
content-type	`application/json`	Static value

Responses

The expected responses from the web hook end point is as follows:

HTTP Response Code	Description
200	The message was accepted and request was successful
400	The message was malformed. (Do not retry)
401	The authentication failed and message could not be processed (Do not retry)
404	The endpoint does not exist (Do no retry)
429	Request quota was exceeded. Retry after sometime
500	Internal server error. Retry after sometime