Authentication & First Request

Use this guide to make your first successful call to the NTRVSTA External Integrations API.

Authentication

Authenticate each request with your organization-scoped API key using either:

• X-Ntrvsta-Api-Key: <your-key>
• Authorization: Bearer <your-key>

First Flow

The most common sequence is:

1. Create a reusable template
2. Create an interview invitation for a candidate
3. Poll for interview results

First Request Example

curl --request POST \
  --url https://example.execute-api.us-east-1.amazonaws.com/dev/v1/templates \
  --header 'Content-Type: application/json' \
  --header 'X-Ntrvsta-Api-Key: <your-api-key>' \
  --data '{
    "title": "Senior Backend Engineer",
    "description": "Backend engineering interview for distributed systems candidates"
  }'

externalPostingId is optional. Include it when you want idempotent create-or-reuse behavior for the same external posting.

Next Step

Once you have your API key and first template payload ready, continue in the live API Reference for schema details and request testing.