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]