Authentication & First Request
Make your first successful call to the NTRVSTA External Integrations API.
Use this guide to make your first successful call to the NTRVSTA External Integrations API.
At a glance
Make one authenticated request before building the full flow
Confirm that your API key, base URL, and request format work before wiring NTRVSTA into an ATS, job board, or automation system.
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:
- Create a reusable template
- Create an interview invitation for a candidate
- Poll for interview results
First Request Example
curl --request POST \
--url https://partners.ntrvsta.com/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.
WebhooksBeta
Receive signed `result.completed` events from the NTRVSTA External Integrations API.
Create an interview template POST
Create a new interview template, or return an existing one when the same `externalPostingId` is already mapped. Use `whiteboardDesign` to control whether the generated template includes the shared whiteboard-design flow.