Webhooks

Manage analytics webhooks.

Supported Formats

json
>>>

POST https://api.vidyard.com/dashboard/v1/organizations/:organization_id/webhooks/analytics
Registers an analytics webhook

Registers an analytics webhook

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
{
  "url": "https://my.url.com",
  "security_key": "secure-token",
  "event_subscriptions": ["view", "identified_view", "attention_span"],
}

RESPONSE
201 (OK)
{
  "webhook_id": 1,
  "status": "Successfully registered the webhook"
}

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
url
required

Target Url

Validations:

  • Must be a String
security_key
required

A secure token that is sent along for validation of request authenticity

Validations:

  • Must be a String
event_subscriptions
required

Events that webhook subscribes to. Options are: “view”, “identified_view”, “attention_span”

Validations:

  • Must be an array of [view, identified_view, attention_span]
>>>

DELETE https://api.vidyard.com/dashboard/v1/organizations/:organization_id/webhooks/analytics/:id
Deletes an analytics webhook

Deletes an analytics webhook

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)
{
  "status": "Successfully deleted the webhook"
}

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/:organization_id/webhooks/players
Registers a webhook that listens to changes on players

This endpoint allows you to register a webhook that listens for changes made to players in a user’s account. A player is the parent object that users make changes to whenever they modify a video in their account library.

There are 2 types of player objects that can subscribe to event_subscriptions:

  • videofacade: a player with a single video
  • playlist: a player that contains multiple videos

There are 3 types of events that the webhook can listen for:

  • create: when a new player is created
  • update: when any aspect of an existing player is modified
  • destroy: when a player is deleted

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
{
  "url": "https://my.url.com",
  "security_key": "secure-token",
  "event_subscriptions": ["videofacade_create", "videofacade_update", "videofacade_destroy", "playlist_create", "playlist_update", "playlist_destroy"],
}

RESPONSE
201 (OK)
{
  "webhook_id": 1,
  "status": "Successfully registered the webhook"
}

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
url
required

Target Url

Validations:

  • Must be a String
security_key
required

A secure token that is sent along for validation of request authenticity

Validations:

  • Must be a String
event_subscriptions
required

Events that webhook subscribes to. Options include: “videofacade_create”, “videofacade_update”, “videofacade_destroy”, “playlist_create”, “playlist_update”, “playlist_destroy”

Validations:

  • Must be an array of any type
settings
optional , nil allowed

Settings for the webhooks in the json format

Validations:

  • Must be a Hash
>>>

DELETE https://api.vidyard.com/dashboard/v1/organizations/:organization_id/webhooks/players/:id
Delete a webhook that listens to changes on players

Deletes a webhook that listens to changes on players

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)
{
  "status": "Successfully deleted the webhook"
}

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