Developer Resources

Integrate your systems with Review Works using our REST API. Create cases, manage workflows, and track events programmatically.

API Overview

The Review Works API allows external systems to create and manage environmental review cases programmatically. This is useful for integrating with existing workflows or automating case submissions.

Base URL

All REST API endpoints follow this pattern:

text
{SUPABASE_URL}/rest/v1/{table_name}

Required Headers

All API requests require these headers:

text
apikey: {SUPABASE_ANON_KEY}
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json
Prefer: return=representation

Integration Flow

To create an environmental review case programmatically:

  1. Authenticate - Sign in to get a user ID and access token
  2. Create Project - Create the project record with case data
  3. Create Process Instance - Link a workflow to the project
  4. Create Initial Task - Create the first task for the applicant
  5. Create Documents - Create document records for document steps
  6. Log Case Events - Record workflow milestones

Decision Elements (Workflow Steps)

The Review Works workflow has 5 decision elements:

IDTitleRoleDescription
1User IDApplicantAuthentication data
2Project InformationApplicantProject details form
3Analysis DocumentApplicantDraft document
4Environmental ReviewAnalystAnalyst review document
5ApprovalApproverFinal approval decision

Need help integrating with Review Works? Learn more about our platform or contact your administrator.