API Overview
WiseWay provides a RESTful API that allows you to integrate the platform with your existing tools and workflows.
Authentication
All API requests must include your API key in the request headers:
x-api-key: your-api-key-hereAPI keys are created in Settings > API Keys. Each key is shown only once at creation — store it securely.
Base URL
https://app.wiseway.video/apiKey Endpoints
Positions
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/app/positions | List all positions |
| POST | /api/app/positions | Create a new position |
| GET | /api/app/positions/:id | Get position details |
| PUT | /api/app/positions/:id | Update a position |
| DELETE | /api/app/positions/:id | Delete a position |
Candidates
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/app/positions/:id/candidates | List candidates for a position |
| POST | /api/app/positions/:id/candidates | Invite a candidate |
| DELETE | /api/app/positions/:id/candidates/:candidateId | Remove a candidate |
Webhooks
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/app/webhooks | List webhooks |
| POST | /api/app/webhooks | Create a webhook |
| PUT | /api/app/webhooks/:id | Update a webhook |
| DELETE | /api/app/webhooks/:id | Delete a webhook |
Webhook Events
Webhooks allow you to receive real-time HTTP POST notifications when events happen in your account.
| Event | Fires When |
|---|---|
interview.completed | A candidate finishes their interview |
interview.started | A candidate begins their interview |
candidate.invited | A candidate is added and invited |
candidate.created | A candidate is created (without invitation) |
position.created | A new position is created |
position.updated | A position is modified |
Webhook Payload
Each webhook delivery includes:
- The event type
- A JSON payload with relevant data (candidate details, position info, timestamps)
- A signature header for validation
Rate Limits
API requests are rate-limited to protect service quality. If you receive a 429 Too Many Requests response, wait before retrying. Contact support if you need higher limits for bulk operations.