Event Joins

Attach an Event to a resource

Supported Formats

json
>>>

GET https://api.vidyard.com/dashboard/v1/organizations/:id/events
Get all events belonging to your organization, with their timing information.

Get all events belonging to your organization, with their timing information.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
[
  {
    "event_id": 8192,
    "second": 4,
    "duration": 2
    "event": {
      "event_type": "custom",
      "html": "<div class=\"main\">Checkout my CTA!</div>"
      ...
    }
  },
  {
    "event_id": 9297,
    "second": 6,
    "duration": 4
    "event": {
      "event_type": "custom",
      "html": "<div class=\"main\">Checkout my CTA!</div>"
      ...
    }
  }
]

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
>>>

POST https://api.vidyard.com/dashboard/v1/organizations/:id/events
Add a default event to a organization

Add a default event to a organization

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Content-Type: application/json
{
  "event_id": 8192,
  "second": 4,
  "duration": 2
}

RESPONSE
200 (OK)
{
  "event_id": 8192,
  "second": 4,
  "duration": 2
  "event": {
    "event_type": "custom",
    "html": "<div class=\"main\">Checkout my CTA!</div>"
    ...
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
event_id
required

The ID of the default event to add to this organization.

Validations:

  • Parameter has to be Integer.
second
required

The second the event will start on. A setting of “-1” will designate the event as a Post-Roll

Validations:

  • Parameter has to be Integer.
duration
required

The duration of the event.

Validations:

  • Parameter has to be Integer.
annotation_css
optional , nil allowed

Custom display settings if the event is an annotation

Validations:

  • Must be a Hash
>>>

PATCH https://api.vidyard.com/dashboard/v1/organizations/:id/events/:event_id
Modify an existing organization's default event

Modify an existing organization’s default event

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Content-Type: application/json
{
  "second": 4,
  "duration": 2
}

RESPONSE
200 (OK)
{
  "event_id": 8192,
  "second": 4,
  "duration": 2
  "event": {
    "event_type": "custom",
    "html": "<div class=\"main\">Checkout my CTA!</div>"
    ...
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
second
optional

The second the event will start on. A setting of “-1” will designate the event as a Post-Roll

Validations:

  • Parameter has to be Integer.
duration
optional

The duration of the event.

Validations:

  • Parameter has to be Integer.
annotation_css
optional

Custom display settings if the referenced event is an annotation

Validations:

  • Must be a Hash
>>>

DELETE https://api.vidyard.com/dashboard/v1/organizations/:id/events/:event_id
Delete a default event from an organization.

Delete a default event from an organization.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "event_id": 8192,
  "second": 4,
  "duration": 2
  "event": {
    "event_type": "custom",
    "html": "<div class=\"main\">Checkout my CTA!</div>"
    ...
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String