Vimeo OTT allows you to use webhooks to be notified when an event has occurred in the lifecycle of any of your customers. A guide on how to create webhooks can be found here. Below is a reference for all the webhook topics Vimeo OTT supports including which platforms support them, a description, and what user-action triggers them.
customer.created
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Description: When a user account is created.
Trigger(s):
- A user registers for the site through the checkout flow.
- A user signs up for the site’s mailing list on the web (note: The properties “registered to site” and “subscribed to site” in this case will be set to False).
- A user without an account is presented a Geoblock message on the web, and submits their email address requesting access to the content (note: The properties “registered to site” and “subscribed to site” in this case will be set to False).
- A site administrator creates a user account for the site.
customer.deleted
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: When a user account is deleted.
Trigger(s):
- A site administrator deletes a user’s account from the site.
customer.updated
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: When a field in a user’s profile is updated.
Trigger(s):
- A user updates their name, email, or marketing emails preference.
- A site administrator updates a user’s name, email, or marketing emails preference.
customer.product.created
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y* |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Description: When a user is added to a subscription product.
Trigger(s):
- A user purchases a subscription product and begins their free trial.
- A user purchases a subscription product without a free trial and their card is billed immediately.
- A site administrator adds a user to a subscription product.
*This webhook does not fire on the Web platform after a user signs up for a free trial. In order to track free trial starts on the Web platform, use the "customer.product.free_trial_created" webhook instead. If you do not offer a free trial, you can continue to use this webhook to track users that purchase a subscription.
customer.tvod.created
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: When a user purchases or rents a TVOD product.
Trigger(s):
- A user purchases or rents a TVOD product.
- A site administrator gives a user buy or rent access to a TVOD product.
customer.product.free_trial_created
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
N |
Description: When a user is added to a subscription product and begins their free trial.
Trigger(s):
- A user purchases a subscription product with a free trial and starts the free trial period.
customer.product.free_trial_converted
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
N |
Description: When a user’s free trial period ends and they are charged for the first time for their subscription.
Trigger(s):
- A user’s subscription status has shifted from a free trial to paying and the user is charged for the first time.
customer.product.free_trial_expired
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
N |
Description: When a user terminates their free trial and does not convert to a paying subscriber.
Trigger(s):
- A user has terminated their subscription during the free trial period.
customer.product.renewed
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Description: A user’s subscription has renewed.
Trigger(s):
-
A user’s subscription has renewed. Note, for annual subscriptions, this webhook will fire on a monthly basis. Use the "last_payment_date" and "next_payment_date" fields in the webhook response to determine if a payment was made or not.
customer.product.updated
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: A user’s subscription duration has been updated.
Trigger(s):
- A user changes the duration of their subscription from monthly to annual, or from annual to monthly.
customer.product.set_paused
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: A user initiates a pause of their subscription that goes into effect at the end of the current billing cycle.
Trigger(s):
- A user has set their subscription to be updated to a paused state.
customer.product.undo_set_paused
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: A user undoes their intention to set their subscription to a paused state.
Trigger(s):
- A user reactivates their subscription that was set to be paused. This is done prior to their subscription entering into a paused state.
customer.product.paused
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: A user’s subscription is paused.
Trigger(s):
- A user’s subscription has entered into a paused state.
customer.product.resumed
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: A user who has a paused subscription, restarts their subscription.
Trigger(s):
- A user who had a subscription in a paused state restarts their subscription and is charged.
customer.product.set_cancellation
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: A user initiates the cancellation of their subscription that goes into effect at the end of the current billing cycle.
Trigger(s):
- A user has set their paid subscription to be updated to a canceled state.
⚠️Note: This webhook does not fire if the user is in a free trial.
customer.product.undo_set_cancellation
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: A user undoes their intention to set their subscription to a canceled state.
Trigger(s):
- A user reactivates their subscription that was set to be canceled. This is done prior to their subscription entering into a canceled state.
customer.product.cancelled
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
N |
N |
N |
N |
N |
Description: A user’s subscription is canceled.
Trigger(s):
- A user’s subscription has reached the end of their subscription date and is no longer active due to the user canceling the subscription.
customer.product.expired
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Description: A user’s subscription has expired due to them not renewing their subscription or having a billing issue. The user can no longer access their subscription content.
Trigger(s):
- On the Web, after multiple failed attempts to charge the customer's card, we determined that they should no longer have access.
- On Apps (IAP), the user cancelled their subscription and they should no longer have access.
- The user had temporary free access to a subscription, which ended.
customer.product.disabled
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Description: A user's subscription is disabled and they can no longer access their subscription.
Trigger(s):
- On the Web, the user was disabled by a system administrator.
- On Apps (IAP), we were unable to determine if the user should continue to have access (due to an IAP billing or subscription-related issue) and therefore we disable their subscription.
customer.product.charge_failed
|
Web |
iOS |
tvOS |
Android |
Android TV |
Fire TV |
Roku |
API |
|
Y |
N |
N |
Y |
Y |
N |
N |
N |
Description: A user's credit card failed to be charged.
Trigger(s):
- An error occurred when attempting to charge the user’s credit card. The charge failed.