Webhooks are advanced functionality that allow you to send data out of Uscreen when a particular event takes place. So for example, if a user makes a purchase you could send the purchase data somewhere else to send a custom email, or add the user to a list in another software. Zapier will cover some of the functionality of Webhooks without the need for code, but there are situations where you need a bit more flexibility which is where webhooks come into play.
Setting up webhooks may require the help of a developer or someone familiar with programming. If you do not have this type of assistance, we recommend using the Zapier integration as it has many of the same functions.
To setup webhooks:
-Navigate to the Settings tab and select Webhooks
-Click New webhook
-Fill in Callback URL and choose and Event Type
-Click Create to save changes
Data available for each webhook action:
User Created
name: User name
email: User email
custom_fields: Array with custom fields
Order Paid
id: Order id
title: Order title
total: Total
amount: Amount paid
discount: Discount
offer_id: Offer ID
customer_name: Customer name
customer_email: Customer email
Access Cancelled
id: Subscription ID
name: User name
email: User email
offer_id: Offer ID
offer_title: Offer title
Recurring Payment Successful
id: Subscription ID
name: User name
email: User email
offer_id: Offer ID
offer_title: Offer title
Watched Video*
title: Video
title_id: Video ID
name: Customer name
email: Customer email
Video Played
title: Video title
id: Video ID
name: Customer name
email: Customer email
chapter_id: Chapter Id
User Signed In
name: User name
email: User email
custom_fields: Array with custom fields
Added to Favorites
title: Chapter title
id: Chapter ID
name: User name
email: User email
Purchased Offer
id: Subscription internal ID
name: User name
email: User email
offer_id: Offer ID
offer_title: Offer title
Document Download
title: Document title
id: Document ID
name: Customer name
email: Customer email
Invoice Overdue
invoice_id: Invoice ID
user_id: Customer ID
name: Customer name
email: Customer email
title: Invoice title
final_price: Invoice final price
Program Completed
name: Customer name
email: Customer email
user_id: Customer ID
program_id: Program ID
title: Program title
Additional Notes on Webhooks
The following webhooks are deprecated for Uscreen versions 8.4.0 and higher: Watched Video
The Video Played webhook will only fire when a video page (/programs/{video-url}) is landed on and the end-user has access to view that content. This does not mean that video itself was actually played, in the event the end-user has autoplay turned off.