Webhooks are an advanced functionality that allows 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.

Using webhooks with Zapier will allow you to extend the functionality of Zapier, as Zapier will allow you to send webhook data to them to use as a trigger. Search "Webhooks by Zapier" to use a webhook as a trigger event.

Outside of using webhooks with Zapier, setting up webhooks may require the help of a developer or someone familiar with programming.

NOTE: To integrate Uscreen with Zapier or use Webhooks, you need to be part of the Growth or Uscreen Plus plan. If you would like to know more about our plans, visit our pricing page or contact our sales team at sales@uscreen.tv.

To Set Up Webhooks:

1. Navigate to the Settings tab and select Webhooks

2. Click New webhook

3. Fill in Callback URL and choose an Event Type

4. Click Create to save changes

Know What Data Is Available for Each Webhook Action

User Created

name: User name

email: User email

custom_fields: Array with custom fields

User Updated

id: User id

name: User name update

email: User email update

subscription_status: User subscription status update

field_1: User custom field 1 update

field_2: User custom field 2 update

field_3: User custom field 3 update

bounced_email: true or false

lifetime_spent: Total lifetime value spent by the User update

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 canceled

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

Began to play video

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: Video ID

collection_id: Collection ID (this value is added only if the video was played inside a collection)

name: User name

email: User 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

Assigned Offer

id: Subscription internal ID

name: User name

email: User email

offer_id: Offer ID

offer_title: Offer title

Payment Method Updated

id: Customer ID

name: Customer Name

email: Customer Email

custom_fields: Array with custom fields

Additional Notes on Webhooks

Specifications on Webhooks:


The Began to play video webhook will only fire when a video is played for the first time, and the end-user has access to view that content. This does not mean that the video was played in its entirety, just that the video was started and viewed for some duration greater than zero seconds.

NOTE: The webhook previously named Video Played has been changed to Began to play video.

Deprecated Webhooks:

The following webhooks are deprecated for Uscreen versions 8.4.0 and higher:

  • Watched Video

Sending a Response to Webhooks:

To acknowledge that you received the webhook without any problem, your server should return a 200 HTTP status code. You need to respond to the Webhook within 5 seconds.

Any other information you return in the request headers or request body will be ignored. Any response code outside of 200, including 3xx codes, will indicate that you did not receive the webhook.

Did this answer your question?