Properties of a webhook payload

When you set up a webhook, Vimeo OTT sends a message –– referred to as a payload  –– to your catching provider of choice (e.g. Zapier) when an event occurs within the customer's lifecycle. While there are various triggering events, each includes a standard set of information about the customer for whom the event occurred.

In this article

• What are the properties of a webhook payload?

What are the properties of a webhook payload?

Here's an example of what part of a raw payload looks like:

Below is an alphabetical reference for what properties are included in the payload and examples of what you may see.

Property	Description	Type	Example(s)
campaign	The campaign associated with the purchase	string	SEARCH_Ad_Campaign/adwords
coupon_code	The coupon code that was used	string	fall21
created_at	Date and time the user was created	datetime	2020-03-02T17:17:50Z
email	The email address of the user	string	[e-mail]
first_name	The first name of the user	string	john
id	The unique id of the user	integer	12345678
last_name	The last name of the user	string	doe
last_payment_date	Date the last payment was made	DateTime	2021-03-17T00:39:26Z
location	The location of the user, if known. Includes city, region and country.	strings	city: Brooklyn region: NY country: United States
marketing_opt_in	Did the user opt in to receive marketing messages	boolean	true
name	The full name of the user	string	john doe
next_payment_date	Date the next payment is due	datetime	2022-03-17T00:39:26Z
pause_end_date	For subscribers that have paused their subscription, the end date of the pause period	datetime	2021-04-17T00:39:26Z
plan	The plan the user is part of	string	standard
platform	The platform the user signed up on	string	web
products	All the metadata related to the product that was purchased. Includes fields like ID, name, description, pricing, and more.	varies (integers, strings, numbers, datetimes)	id: 15275 name: Purple Fitness description: Fitness Lives Here
promotion_code	The promotion code that was used	string	holiday21
referrer	The referrer associated with the purchase	string	vimeo.com
registered_to_site	Is the user registered to the site	boolean	true, false
subscribed_to_site	If the user subscribed to the site	boolean	true, false
subscription_currency	three letter code of the currency transacted when known (default is USD)	string	USD, AUD,  JPY
subscription_frequency	The type of subscription that the user has (monthly, annual, custom)	string	annual, monthly, custom
subscription_price	The cost of the subscription, in cents	number	5000
subscription_status	The current subscription status of the customer	string	free_trial, enabled, canceled, expired, disabled, paused,
updated_at	Date and time the user was last updated	datetime	2021-03-17T00:39:26Z