JobMojito
HomePublic pageAdmin app
HomePublic pageAdmin app
  1. Actions API
  • Welcome
  • API keys creation
  • API usage and libraries
  • Vibe coding
  • Platform
    • Interview credits
    • Interview workflow
    • Interview types
    • Scoring
    • Scoring verification: using Psychometric assessment
    • Risk assessment
    • Data privacy model
    • Custom web domain
    • Multi language support
    • Avatars
  • Actions API
    • Invite, Create interview URL for users
      POST
    • Invite, Interview URL for existing user
      POST
    • Invite, Email users invitation
      POST
    • Interview result, details with transcript
      POST
    • Interview result, generate html/PDF report
      POST
    • Create interview, using position data
      POST
    • Create interview, using position data & candidate pre-screening
      POST
    • Create interview, using provided questions
      POST
    • Candidate request another interview attempt
      POST
    • New knowledge base document
      POST
  • Tables API
    • interview_def_set
      • /interview_def_set
      • /interview_def_set
      • /interview_def_set
      • /interview_def_set
    • interview_def_pre_screening
      • /interview_def_pre_screening
      • /interview_def_pre_screening
      • /interview_def_pre_screening
      • /interview_def_pre_screening
    • interview_def_question
      • /interview_def_question
      • /interview_def_question
      • /interview_def_question
      • /interview_def_question
    • interview_def_response
      • /interview_def_response
      • /interview_def_response
      • /interview_def_response
      • /interview_def_response
    • interview_file
      • /interview_file
      • /interview_file
      • /interview_file
      • /interview_file
    • interview_file_page
      • /interview_file_page
      • /interview_file_page
      • /interview_file_page
      • /interview_file_page
    • interview_result
      • /interview_result
      • /interview_result
      • /interview_result
      • /interview_result
    • interview_templates
      • /interview_templates
      • /interview_templates
      • /interview_templates
      • /interview_templates
    • interview_result_question
      • /interview_result_question
      • /interview_result_question
      • /interview_result_question
      • /interview_result_question
    • interview_result_pre_screening
      • /interview_result_pre_screening
      • /interview_result_pre_screening
      • /interview_result_pre_screening
      • /interview_result_pre_screening
    • knowledge_base
      • /knowledge_base
      • /knowledge_base
      • /knowledge_base
      • /knowledge_base
    • knowledge_base_store
      • /knowledge_base_store
      • /knowledge_base_store
      • /knowledge_base_store
      • /knowledge_base_store
    • knowledge_base_chunks
      • /knowledge_base_chunks
      • /knowledge_base_chunks
      • /knowledge_base_chunks
      • /knowledge_base_chunks
    • position_def_set
      • /position_def_set
      • /position_def_set
      • /position_def_set
      • /position_def_set
    • position_def_step
      • /position_def_step
      • /position_def_step
      • /position_def_step
      • /position_def_step
    • position_result
      • /position_result
      • /position_result
      • /position_result
      • /position_result
    • position_result_step
      • /position_result_step
      • /position_result_step
      • /position_result_step
      • /position_result_step
    • profile
      • /profile
      • /profile
      • /profile
      • /profile
    • profile_interview
      • /profile_interview
      • /profile_interview
      • /profile_interview
      • /profile_interview
  • Webhooks
    • Creating webhooks
    • Webhook: Interview submitted
  1. Actions API

Invite, Create interview URL for users

POST
/job-interview-register-users
Based on the field type, this endpoint will:
a) When type is url, endpoint will generate a public interview URL for a specific user. This URL contains JWT token and specific user should be redirected to this URL.
b) When type is invitation, endpoint will generate public interview URL & subscribe the user to our email chain to receive an invitation email, reminder emails, and all notifications necessary to complete the interview.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🔴500Server error
🟠422Invalid input
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://cool.jobmojito.com/functions/v1/job-interview-register-users' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "interview_id": "4316a76e-ab40-4dce-97fa-4db3f8caf3c4",
    "type": "url",
    "hide_menu": false,
    "users": [
        {
            "name": "Peter Parker",
            "email": "peter@parker.com",
            "external_id": "abcd"
        },
        {
            "name": "mr beast",
            "email": "hi@example.com"
        }
    ]
}'
Response Response Example
200 - Example 1
[
    {
        "name": "Peter Parker",
        "email": "peter@parker.com",
        "external_id": "abcd",
        "interview_url": "https://....",
        "profile_interview_id": "19bd7229-7f5c-4686-917a-2687d3e6bae4",
        "result": "ok"
    },
    {
        "name": "mr beast",
        "email": "hi@example.com",
        "result": "Error: ...."
    }
]
Modified at 2025-07-15 11:17:07
Previous
Avatars
Next
Invite, Interview URL for existing user
Built with