Integrations

Learn how to integrate your academy with your applications easily.

0% Completed
Webhooks Integration
  • Create an HTTP POST end point at your end with basic authentication

    • Share the URL end point along with the auth details to us. In the future, we will be providing an UI where you can update these end points

    • Also share what events you would like to get subscribed to. Right now, we can send the below events

      • when the user has started watching the video,

      • when the progress percentage reaches 25%, 50% and 75%

      • when the user has watched the entire video

    • We will be posting the subscribed event data in the form of JSON. Please check the below sample JSON data

    • We will retry posting the event for 7 times till we get 2xx status. The gap between the consecutive retries will be 2 minutes, 6 minutes, 30 minutes, 1 hour, 5 hour, 1 day and 2 day

  • Sample data of the event that will be posted

{"data": {
	"id": "662d549a-5af1-4779-95ba-67719d062a06",
	"content": {
		"customer": {
			"id": "e76bf50f-8879-4973-9f87-b01bfdec4995",
			"company": null,
			"created_at": 1642478837,
			"created_via": "from_api",
			"email": "abigochat@gmail.com",
			"external_id": "4438b7ed-6072-4b3b-9161-16978452a95b",
			"first_name": "Abishek",
			"last_accessed_at": 1647431124,
			"last_name": "P.Y"
		},
		"video": {
			"id": "caa9b240-9681-4e1a-92e7-77fbaefb4879",
			"created_at": 1647251665,
			"duration": 63.4,
			"narration_type": "tts",
			"narration_voice_id": "Joanna",
			"published_version_id": 11418,
			"title": "How to Create a Folder and Add videos"
		},
		"engagement_activity": {
			"id": 63317,
			"activity_type": "video",
			"completed": true,
			"completed_at": 1647431179,
			"created_at": 1647431124,
			"progress": "100.0"
		}
	},
	"created_at": 1647431179,
	"event_type": "video.engagement.completed",
	"log": "User has finished watching the video 'How to Create a Folder and Add videos'"
}
}

Kindly reach out to us for any questions.

S

Sumana Ammaiyappan

Updated on Feb 02, 2023