284313f908
Some checks are pending
Bidi Control Character Guard / bidi-control-guard (push) Waiting to run
Circular Dependency Check / Check for new circular dependencies (push) Waiting to run
Citus Migration Smoke / Combined migrations on single-node Citus (push) Waiting to run
E2E Fresh Install Tests / fresh-install-e2e (push) Waiting to run
ext-v2 guardrails / Run ext-v2 guard and ESLint (push) Waiting to run
Integration Tests / Check for relevant changes (push) Waiting to run
Integration Tests / ${{ (github.event_name == 'schedule' || github.event.inputs.suite == 'full') && 'Full integration suite' || 'Tier-1 integration subset' }} (push) Blocked by required conditions
Mobile checks / Mobile lint + typecheck (push) Waiting to run
Mobile checks / Mobile unit tests (push) Waiting to run
Mobile checks / Mobile dependency audit (report) (push) Waiting to run
Mobile checks / Mobile reproducibility checks (push) Waiting to run
Secrets guard (env backups) / Ensure no tracked env backup files (push) Waiting to run
Temporal Readiness / fast-readiness (push) Waiting to run
Temporal Readiness / docker-parity (push) Waiting to run
TypeScript Type Check / Nx affected typecheck (push) Waiting to run
Unit Tests / Skipped-test budget (push) Waiting to run
Unit Tests / Nx affected unit tests (push) Waiting to run
Unit Tests / Server unit coverage (informational) (push) Waiting to run
Validate Tenant Management Schema / Check for relevant changes (push) Waiting to run
Validate Tenant Management Schema / Validate Tenant Management Schema (push) Blocked by required conditions
EE Workflows Build Guard / ee-workflows-build-guard (push) Waiting to run
Excluded: .git, node_modules, secrets/, compose.env, assemblyscript tgz Source: /opt/alga-psa on psa.joliet.tech
51 lines
1.2 KiB
Markdown
51 lines
1.2 KiB
Markdown
# API Reference – Inbound Email
|
||
|
||
Canonical reference for all HTTP endpoints and callback payloads used by the inbound-email feature.
|
||
|
||
## 1. OAuth
|
||
|
||
### Initiate OAuth
|
||
|
||
`POST /api/email/oauth/initiate`
|
||
|
||
| Body | Type | Description |
|
||
|-------------------|--------|-------------|
|
||
| providerId | string | Draft provider record ID |
|
||
| successRedirect | string | URL to redirect popup on success |
|
||
|
||
### Callback
|
||
|
||
`GET /api/email/oauth/google/callback`
|
||
|
||
Upon success the endpoint stores tokens, then calls
|
||
`configureGmailProvider(providerId, { tenant, force:false })`.
|
||
|
||
#### Query Parameters
|
||
|
||
| Param | Desc |
|
||
|-------|------|
|
||
| code | OAuth grant code |
|
||
| state | Encrypted JSON with tenant, user, nonce |
|
||
|
||
## 2. Refresh Watch (Pub/Sub + Gmail Watch)
|
||
|
||
`POST /api/email/refresh-watch`
|
||
|
||
Triggers `configureGmailProvider({ force:true })` for a specific Gmail provider.
|
||
|
||
| Body | Type | Description |
|
||
|------------|--------|-------------|
|
||
| providerId | string | Gmail provider record ID |
|
||
|
||
## 3. skipAutomation Flag
|
||
|
||
`upsertEmailProvider` and `updateEmailProvider` now accept an **optional** JSON key :
|
||
|
||
```json
|
||
{
|
||
"skipAutomation": true
|
||
}
|
||
```
|
||
|
||
When true, Pub/Sub orchestration is skipped; used by UI **Save** button to avoid extra initialisations.
|