All Integration API endpoints require the following authentication:

• Pass the API key in the HTTP header X-Corvus-API-Key
• Pass the API secret in the HTTP header X-Corvus-API-Secret

API credentials can be managed under Admin → Integrations → Integration API Keys (requires Application Admin role).

Creates a new user or updates an existing user. Idempotent — sending the same logical user multiple times results in the same outcome. Use for nightly sync or delta updates from your SIS.

Web Service: POST https://dm.corvussg.com/api/v1/integration/users

Input

facultyProfile (optional, for Faculty/Chair)

Response

Example

curl -X POST "https://dm.corvussg.com/api/v1/integration/users" \
  -H "Content-Type: application/json" \
  -H "X-Corvus-API-Key: your-api-key" \
  -H "X-Corvus-API-Secret: your-api-secret" \
  -d '{"email":"jane.doe@uni.edu","firstName":"Jane","lastName":"Doe","accountType":"Student","externalId":"SIS-12345"}'

With faculty profile (Faculty/Chair):

curl -X POST "https://dm.corvussg.com/api/v1/integration/users" \
  -H "Content-Type: application/json" \
  -H "X-Corvus-API-Key: your-api-key" \
  -H "X-Corvus-API-Secret: your-api-secret" \
  -d '{"email":"dr.smith@uni.edu","firstName":"Jane","lastName":"Smith","accountType":"Faculty","role":"chair","facultyProfile":{"highestDegree":"PhD","degreeField":"Education","facultyRank":"Professor","contentExpertiseTags":["Leadership"],"methodsExpertise":["qualitative"],"committeeRolesSupported":["chair","content_expert"],"availabilityStatus":"available"}}'

Matching logic: externalId (950/951) → legacyNumber → email. If no match, a new user is created.

Soft de-provisions or restores a user. De-provisioning sets accountStatus: "inactive" — user cannot log in, but data is preserved.

Web Service: PATCH https://dm.corvussg.com/api/v1/integration/users/:id

Path Parameters

Request Body (optional)

Example (De-provision)

curl -X PATCH "https://dm.corvussg.com/api/v1/integration/users/9509922064" \
  -H "Content-Type: application/json" \
  -H "X-Corvus-API-Key: your-api-key" \
  -H "X-Corvus-API-Secret: your-api-secret" \
  -d '{"accountStatus":"inactive"}'

Returns student progress data for export to SIS/CRM. Use for nightly sync or on-demand reporting. Includes dissertation versions, milestones, pacing status, and committee formation.

Web Service: GET https://dm.corvussg.com/api/v1/integration/progress

Query Parameters

Example

curl -s "https://dm.corvussg.com/api/v1/integration/progress?studentId=9509922064" \
  -H "X-Corvus-API-Key: your-api-key" \
  -H "X-Corvus-API-Secret: your-api-secret"

These endpoints provide a connector-ready queue and payload preview for future SIS/CRM/LMS integrations. They are safe by design: they only read/update internal Corvus queue metadata and do not call external systems.

Primary future targets include PeopleSoft (SIS), Salesforce (CRM), and Canvas (LMS). Connector code is intentionally not enabled in this scaffold.

1) List Queue

Web Service: GET https://dm.corvussg.com/api/v1/integration/sync/queue

curl -s "https://dm.corvussg.com/api/v1/integration/sync/queue?status=queued&limit=50" \
  -H "X-Corvus-API-Key: your-api-key" \
  -H "X-Corvus-API-Secret: your-api-secret"

2) Payload Preview

Web Service: GET https://dm.corvussg.com/api/v1/integration/sync/payload/:submissionId

Returns the outbound envelope that a future connector would send. This is preview-only and does not transmit data externally.

curl -s "https://dm.corvussg.com/api/v1/integration/sync/payload/<submission-id>" \
  -H "X-Corvus-API-Key: your-api-key" \
  -H "X-Corvus-API-Secret: your-api-secret"

3) Replay Control

Web Service: POST https://dm.corvussg.com/api/v1/integration/sync/replay

Re-queues a submission for a future connector run by setting internal queue status to queued. No external API is called.

curl -X POST "https://dm.corvussg.com/api/v1/integration/sync/replay" \
  -H "Content-Type: application/json" \
  -H "X-Corvus-API-Key: your-api-key" \
  -H "X-Corvus-API-Secret: your-api-secret" \
  -d '{"submissionId":"<submission-id>","targetSystem":"peoplesoft"}'

4) Connector Ack Stub

Web Service: POST https://dm.corvussg.com/api/v1/integration/sync/ack

Updates internal queue state as if an external connector responded. Accepted statuses:processing,sent,failed.

curl -X POST "https://dm.corvussg.com/api/v1/integration/sync/ack" \
  -H "Content-Type: application/json" \
  -H "X-Corvus-API-Key: your-api-key" \
  -H "X-Corvus-API-Secret: your-api-secret" \
  -d '{"submissionId":"<submission-id>","status":"failed","targetSystem":"salesforce","lastError":"Validation mismatch"}'

Contract Files

• OpenAPI: apiDocs/openapi.sync-scaffold.yaml
• Queue item schema: apiDocs/schemas/forms-sync-queue-item.schema.json
• Envelope schema: apiDocs/schemas/forms-sync-envelope.schema.json

Automatic Queue Trigger

When a form submission is moved to approved or closed in review workflows, Corvus auto-queues sync metadata internally. This still performs no outbound connector call.

Idempotency guard: if an item is already queued or processing, repeated status updates do not re-queue it. Use replay controls for intentional re-queue.

Discrepancy-safe gating: if unresolved mapped-field discrepancies exist, queue attempts are blocked internally and the sync state is marked failed until discrepancies are reviewed.

Health check / connectivity test. Returns 200 if credentials are valid.

Web Service: GET https://dm.corvussg.com/api/v1/integration

Example Response

{
  "success": true,
  "message": "Integration API",
  "tenantId": "default"
}