Integrations

Getting Started

Whether it be with Squarespace, Wordpress, BigCommerce, Shopify, or your own custom built site, integrations are a simple way of integrating Vimeo OTT with your site. If you need deeper customization, see our full API reference.

Checkout Embed

The Checkout Embed allows your customers to purchase your Vimeo OTT Products directly from your site. To get a feel for how it will work on your site, click the button below:

Open the Checkout Embed

To integrate the Checkout embed on your site, include the following script at the bottom of your page:

<!-- include at the bottom of your site inside the body tag -->
<script src="https://cdn.vhx.tv/assets/api.js"></script>

With the included script, any link on your pointing to https://yoursubdomain.vhx.tv/buy/your-product will open the checkout embed with the associated Vimeo OTT Product for purchase.

Trailer Embed

A Vimeo OTT Product can be embedded to show your trailer and buy button anywhere. You can copy the code for your video embed from the Products page of your Vimeo OTT Dashboard. If you'd like to customize it beyond what is out of the box, we offer these query parameters to modify the look.

<!-- Vimeo OTT Trailer Embed -->
<iframe src="https://embed.vhx.tv/packages/15" width="850" height="480" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>

<!-- customize trailer embed features via query params -->
<iframe src="https://embed.vhx.tv/packages/15?color=ffffff&buy_btn=1" width="850" height="480" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>
Parameter Description
auto=1
0 or 1
Enable or disable autoplay on page load. If not included, defaults to 0.
color=ffffff
A valid 3 or 6 digit hexademical
Sets the color of the player. Do not include the # sign. If not included defaults to your site color as set in the Vimeo OTT Dashboard.
buy_button=1
0 or 1
Hide or show the buy button. If not included defaults to 1.
title=1
0 or 1
Hide or show the product title. If not included defaults to 1.
volume=100
0 to 100
Set the starting volume for the trailer on play. If not included, defaults to 50.

Platforms

For more specific instructions on how to integrate with your service of choice see the Vimeo OTT Help links below.

Wordpress

Can I use Vimeo OTT with my Wordpress site?

Squarespace

Bigcommerce

Shopify App

Webhooks

Webhooks allow external services to be notified when customer related events have occured on your Vimeo OTT site. To learn more on adding a specific endpoint to your Vimeo OTT site, please refer to the Vimeo OTT Admin Help.

Recorded Events

The following events will trigger a webhook payload to POST to your endpoint:

Topic Name Description
customer.created Customer is created on your site (i.e. signs mailing list)
customer.updated Customer is updated
customer.product.created Customer is added to a Product
customer.product.deleted Customer is removed from a Product
customer.product.cancelled Customer has cancelled their Subscription
customer.product.paused Customer has paused their Subscription
customer.product.renewed Customer has renewed their Subscription
customer.product.charge_failed Customer's payment has failed charging
customer.product.expired Customer's payment method has expired
customer.product.disabled Customer has been disabled
customer.product.free_trial_created Customer has had a Free Trial created

Webhook Payload

For each recorded event, we will make an HTML POST to the webhook URL with a JSON payload. The webhook must return an HTTP status code of 200. We will retry up to 5 times if we do not receive this status code.

The JSON we POST contains a "topic" key corresponding to the fired event, as well as customer data that will resemble:


{
  "topic": "customer.product.renewed",
  "created_at": "2018-02-15T18:23:59Z",
  "_embedded": {
    "customer": {
      "links": {
        "events": "https://api.vhx.tv/customers/1/events",
        "self": "https://api.vhx.tv/customers/1",
        "watching": "https://api.vhx.tv/customers/1/watching",
        "watchlist": "https://api.vhx.tv/customers/1/watchlist"
      },
      "_embedded": {
        "products": [{
          "links": {
            "self": {"href": "https://api.vhx.tv/products/1"},
            "browse_page": {"href": "http://sitename.vhx.tv/browse/ticket=number"},
            "product_page": {"href": "http://sitename.vhx.tv/products/name/ticket=#"},
            "customers": {"href": "https://api.vhx.tv/customers?product=1"}},
          },
          "id": 1,
          "name": "Subscription!",
          "description": "Super cool subscription.",
          "price": {
            "purchase":
              "cents":999,
              "currency":"USD",
              "formatted":"$9.99"
            }
          },
          "is_active": "true",
          "created_at": "2016-10-03T14:42:34Z",
          "updated_at": "2018-01-17T16:02:45Z",
          "types": ["purchase"]
        }]
      },
      "id": 1,
      "name": "Kevin Sheurs",
      "email": "kevin@vhx.tv",
      "thumbnail": "https://secure.gravatar.com/avatar/ID",
      "location": {"city": "San Francisco", "region": "CA", "country":"United States"},
      "created_at": "2018-02-14T22:40:14Z",
      "updated_at": "2018-02-14T22:40:16Z",
      "plan": "standard",
      "platform": "web",
    }
  }
}