Invitations API Documentation Reference

The Invitations API by Vpply helps you hire using video. The Invitations API is powerred by AWS Infrastructure and follows best practices for data storage and user privacy. If you have any questions, contact joseph@vpply.com via email

Creating an Account

To Create an account, you need to have an employer account with Vpply. Go to emplayers.vpply.com/register to create an account. By default you can create 1 interview as a trial. To create more than 1 interview, please contact sales.

Retrieving API Keys

To retreive your api keys, login to interviews.staging.com/login, go to the settings page and display your primary and secret keys.

Primary Key

Your primary key is used as a way to identify ownership of video content. It can also be used to enable the embed elements. See the embed elements section for more details.

Secret Key

Your secret key is your gateway to the API. All requests to the api must contain the header 'vpply-skey' with your secret key as the value. If you need to reset your secret key, contact support.

Making Your First Request

To make your first request, we will request an invitation for your account. Follow the guide below to make this work.

First, Test your Secret API key using the request below.

            
curl -XGET -H 'vpply-skey: YOUR-SECRET KEY' 'https://invitations-api.staging.vpply.com/v1/test-my-key'
            
          

Set Up Prompts

To Get started using the API, you'll need to set up some prompts. Visit the dashboard, navigate to the "Question Library" tab and record your first question.

Create an Invitation

Now that you have your secret key and prompts setup, you can start using the API to create invitations. To create an invitation, make a POST request to the API. Use the example below to guide you.

At this stage you can also add email recipients to the request. the emails field requires a

            
curl -XPOST -H 'vpply-skey: YOUR-SECRET KEY' -d '{
  title: "My First Interview",
  message: "Welcome to your first interview, hope you enjoy!",
  end_date: 2023-02-02T12:00:00Z,
  hide_videos: false,
  disguise_audo: false,
  emails: []
}' 'https://invitations-api.staging.vpply.com/v1/invitation'
            
          

Now that your invitation is setup, keep the id in the response somewhere to reference later. If you lose your id, you can always list your invitations and find it later.

Add Prompts to your Invitation

Now that you have an invitation setup, you can now add the prompts to it.

To start, list your prompts to get a list of all the prompts in your account.

            
curl -XPATCH -H 'vpply-skey: YOUR-SECRET KEY' 'https://invitations-api.staging.vpply.com/v1/prompts
            
          

Once you have the id's for the prompts you would like to use in your invitation, make a PATCH request to add them to the invitation.

            
curl -XPATCH -H 'vpply-skey: YOUR-SECRET KEY' -d '[
    {
        prompt_id: 1,
        invitation_id: 1,
        prompt_order: 1
    }
]' 'https://invitations-api.vpply.com/v1/invitation/:id/update-prompts'
            
          

If you ever want to update or change the prompts, you can make another request with the prompts again. This request will replace all saved prompts, so each request to update requires ALL prompts you want inside the invitation in each update request.

Add Recipients to you Invitation

As mentioned earlier, you can add recipients when your first create the invitation, but if your invitation is not published, you can continue to add recipients.

            
curl -XPATCH -H 'vpply-skey: YOUR-SECRET KEY' -d '[
    "test@email.com,John,Smith",
    "test2@email.com,Marge,Simpson"
]
            
          

Publish your Invitation

Your invitation is now created, prompts are added and a list of emails have been added to receive the invitation via email. The last thing left to do is publish your invitation. Once published, you can no longer edit it, so make sure everything is ok before making this request.

If you dont want to send an email to recipients, you can add the noemail query parameter as show below.

            
curl -XPATCH -H 'vpply-skey: YOUR-SECRET KEY' 'https://invitations-api.staging.vpply.com/v1/invitation/:id/publish?noemail=true'