It is quite difficult to know when someone takes an action (e.g., filled a form, clicks on a CTA, etc.) on your platform in real-time and in one place. Here is where Webhook comes into the picture. You might have noticed webhooks in your apps' settings and questioned if they're something you should know and use. Of course, you should.
Webhook helps you to get notified as soon as someone takes a desired action on your platform. A Webhook enables an application to send automated messages or information to another application, whenever an event takes place, in real-time. Basically, a Webhook is a medium that enables apps to communicate with each other and share data.
Available events in Webhook
Any change that occurs on an application or a system is considered an event. Here are some default events that we provide:
1) Viewing Session
Find out who watched your video. When someone clicks on your video, we’ll notify you with the watch rate along with other user details (only if the viewer has logged in before watching your video).
Example response:
{
"hook": {
"uuid": "fb9f6d19-921f-48c5-9a10-69c39e5fa13c"
},
"eventName": "VideoPlayedSessions",
"eventTimestamp": "1542364983607",
"VideoPlayedSessions": {
"media": {
"videoId": 444076,
"thumbnail": "https://hippolms-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/21594/da2f955a-5410-489b-a10c-43b7d0a192af_play.jpg",
"downloadUrl": "https://hippolms-storage.s3.amazonaws.com/wiz/videos/converted/352474/35348453.mp4?AWSAccessKeyId=P5TI&Expires=1665750785&Signature=bNSwi4b9XIerkDg%3D&response-content-disposition=attachment",
"name": "Pro edit full flow",
"shareUrl": "https://www.hippovideo.io/video/play/mp1lhvzM9gyOY1mg19Fl2Q",
"embedUrl": "https://www.hippovideo.io/video/embed/mp1lhvzM9gyOY1mg19Fl2Q",
"duration": 171.689
},
"percentagePlayed": 100,
"email": "support@hippovideo.io"
},
"metadata": {
"account_id": "24880"
}
}
2) Video Created
We notify you whenever someone creates a video on your platform.
Example response:
{
"hook": {
"uuid": "598210b8-e373-48eb-ac3f-4b8f08fa8066"
},
"eventName": "VideoCreated",
"eventTimestamp": "1542032461018",
"VideoCreated": {
"media": {
"videoId": 834871,
"thumbnail": "https://hippolms-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/FCNN4s7tKjCOaecmg6hjzw_play.jpg",
"name": "Hey Ashley",
"shareUrl": "https://www.hippovideo.io/video/play/FCNN4s7tKjCOaecmg6hjzw",
"embedUrl": "https://www.hippovideo.io/video/embed/FCNN4s7tKjCOaecmg6hjzw",
"duration": 13.76
}
},
"metadata": {
"account_id": "60753",
"created_by": "support@hippovideo.io"
}
}
3) CTA
Get notified whenever your viewers click on a Call to Action (CTA) in your video.
Example response:
{
"hook": {
"uuid": "ffc5bf89-16e8-428d-92e8-a94016b5e8f2"
},
"eventName": "VideoCTA",
"eventTimestamp": "1542191371256",
"VideoCTA": {
"media": {
"videoId": 809864,
"thumbnail": "https://hippolms-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/c9ryLBsotAVJITn12NZIKg_play.jpg",
"name": "A",
"shareUrl": "https://www.hippovideo.io/video/play/c9ryLBsotAVJITn12NZIKg",
"embedUrl": "https://www.hippovideo.io/video/embed/c9ryLBsotAVJITn12NZIKg",
"duration": 146.912
},
"ctaUrl": "https://www.hippovideo.io/video/cta/809864",
"email": "support@hippovideo.io"
},
"metadata": {
"account_id": "60753"
}
}
4) CTA Lead Generation
Get notified with your leads information. Whenever someone fills a form that you have embedded in your video, you’ll receive an instant notification, with their details. You can also choose to update your leads information straight away into your CRM platform.
Example response:
{
"hook": {
"uuid": "681dc0a4-1baa-497e-b9c4-674a66924f88"
},
"eventName": "VideoLeadGenaration",
"eventTimestamp": "1542020582260",
"VideoLeadGenaration": {
"media": {
"videoId": 826784,
"thumbnail": "https://hippolms-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/U4GZz3AFN8vHcplqEYl7Fg_play.jpg",
"name": "Sales demo",
"shareUrl": "https://www.hippovideo.io/video/play/U4GZz3AFN8vHcplqEYl7Fg",
"embedUrl": "https://www.hippovideo.io/video/embed/U4GZz3AFN8vHcplqEYl7Fg",
"duration": 139.203
},
"firstName": "Varun",
"lastName": "Ch",
"email": "support@hippovideo.io",
"phone": "2132121"
},
"metadata": {
"account_id": "24880"
}
}
5) CTA Annotation
Do you have an annotation that directs your viewers to your website? How do you track who clicked on your annotation? Don’t worry. We notify who’s clicking on your annotation along with the viewer’s information.
Example response:
{
"hook": {
"uuid": "e72c91f5-9c7a-4419-bd1e-c1d3d17ae3ef"
},
"eventName": "VideoAnnotation",
"eventTimestamp": "1541759939981",
"payload": {
"VideoAnnotation": {
"videoId": 814440,
"thumbnail": "https://hippolms-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/cS-qeih4T7LkWzhQnYbzVA_play.jpg",
"name": "Hey, How are you?",
"shareUrl": "https://www.hippovideo.io/video/play/cS-qeih4T7LkWzhQnYbzVAhttps://www.hippovideo.io/video/play/cS-qeih4T7LkWzhQnYbzVA",
"embedUrl": "https://www.hippovideo.io/video/embed/cS-qeih4T7LkWzhQnYbzVA"
},
"annotationText": "Google",
"annotationUrl": "https://www.google.co.in/",
"annotationClickedTime": 0,
"email": "support@hippovideo.io"
},
"metadata": {
"account_id": "60753"
}
}
Note: To add more events, please contact us.
Secret Key
On the other hand, anyone with your server URL can send you a data. To verify the data source, we suggest you create a secret key of your choice. So that whenever you receive information from Hippo Video, you can verify whether the data is from us.
It works this way -
Every time you receive data from our side, we also provide Hippo Video signature in the request. Using the signature, you can verify the data authenticity by checking it at your end.
We’ll generate HMAC hexdigest of the POST body, using the secret_key that you created, while configuring your webhook. The generated hexdigest will be shared with you along with the event data.
If you have any questions, contact us at support@hippovideo.io