Webhooks

A webhook allows your Uscreen store to interact with other applications. 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

Webhooks_-_Add_New.png

-Fill in Callback URL and choose and Event Type

Call_back_and_event_type.png

-Click Create to save changes

Create_webhook.png

 

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
 Subscription Canceled
 id  Subscription ID
 name  User name
 email  User email
 offer_id  Offer ID
 offer_title  Offer title
 Recurring Payment Sucecssful
 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
 Quiz Finished
 title  Quiz title
 id  Quiz ID
 name  Customer name
 email  Customer email
 engagement  Customer engangement on quiz
 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


    *The watched video trigger is deprecated for non-legacy themes/newer versions of the platform.

 

Did this answer your question?

0