myinterview - npm Package Compare versions

Comparing version 1.2.6 to 1.2.7

package.json

		{
		"name": "myinterview",
		"version": "1.2.006",
		"version": "1.2.007",
		"description": "Build and integrate myInterview with ease via our node.js npm package and connect to the myInterview API.",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

		@@ -74,3 +74,34 @@ # MyInterview-node #

		# Getting Started with the API

		This guide provides an overview of the basic flow for using the API, from creating a job and inviting candidates to receiving and viewing completed video interviews.

		## 1. Create Job

		Start by creating a Job Model, which serves as the foundation for your video interviews. Use the `createJob` or `createJobWithCandidates` API endpoints to define various aspects of the interview, such as questions, link appearance, and description.

		## 2. Invite Candidates

		Next, invite candidates to participate in the video interview. Create a Candidate Model for each candidate, associating it with the Job Model you created earlier. Utilize the candidate information to generate a personalized myInterview video interview link and send it to the candidates.

		## 3. Monitor Video Status

		Once candidates have been invited, monitor the status of their video interviews using the Video Model. Set up a webhook to receive real-time notifications when candidates complete their interviews. Configure the webhook by providing a URL where POST requests will be sent upon video completion.

		## 4. Retrieve Completed Videos

		After candidates have completed their video interviews, use the API to access the videos in JSON format, which includes signed URLs for all video questions. Alternatively, obtain a sleek share link that can be opened anywhere by calling the `getShareLink` API endpoint.

		## API Flow

		1. Create Job: Configure a Job Model using the `createJob` or `createJobWithCandidates` API endpoints.
		2. Invite Candidates: Create a Candidate Model for each candidate, associate it with the Job Model, and send personalized interview links.
		3. Wait for Video: Monitor the status of candidate video interviews using the Video Model and webhook notifications.
		4. Get the Video: Access completed video interviews using the API or the share link obtained from the `getShareLink` API endpoint.

		By following this simple flow, you can efficiently manage and monitor video interviews, streamlining the recruitment process and helping you identify the best talent for your organization.

		> Note: This guide outlines a basic flow for using the API, but it is not the only possible workflow. Clients can choose and customize the flow that best suits their specific needs, taking advantage of the API's flexibility and adaptability.


		## Jobs
		@@ -166,5 +197,5 @@ ```js
		},
		template_id: 'any-template-id',
		]
		}
		],
		template_id: 'any-template-id'
		};

		@@ -756,3 +787,3 @@ await Jobs.createJob(body);

		[//]: # (![ShareLink](https://app-service-upload.s3.amazonaws.com/uploads/Screen-Recording-2023-04-12-at-12.05.18.gif))
		![ShareLink](https://app-service-upload.s3.amazonaws.com/uploads/Screen-Recording-2023-04-12-at-12.05.18.gif)
		```ts
		@@ -939,3 +970,3 @@ const id = "video_id"
		It will return:
		```js
		```
		{
		@@ -950,3 +981,3 @@ 'x-myinterview-timestamp': 'headTimestamp',

		* Dvd1190 (David Sellam)
		* dvd90 (David Sellam)

myinterview - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics