Getting Started

Whether it be with Squarespace, 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.

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="" width="850" height="480" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>

<!-- customize trailer embed features via query params -->
<iframe src="" width="850" height="480" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>
Parameter Description
0 or 1
Enable or disable autoplay on page load. If not included, defaults to 0.
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.
0 or 1
Hide or show the buy button. If not included defaults to 1.
0 or 1
Hide or show the product title. If not included defaults to 1.
0 to 100
Set the starting volume for the trailer on play. If not included, defaults to 50.

Checkout Embed

The Checkout Embed has been deprecated. All previous integrations with this tool will now fail silently causing no interruptions in service. Any site using this tool will simply have their Customers redirected to their OTT site, allowing them to continue the checkout experience.


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



Shopify App


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": "",
        "self": "",
        "watching": "",
        "watchlist": ""
      "_embedded": {
        "products": [{
          "links": {
            "self": {"href": ""},
            "browse_page": {"href": ""},
            "product_page": {"href": ""},
            "customers": {"href": ""}},
          "id": 1,
          "name": "Subscription!",
          "description": "Super cool subscription.",
          "price": {
          "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": "",
      "thumbnail": "",
      "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",