Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Mailbox OAUTH apps
A Mailbox OAuth App is the platform customer's own OAuth client at Google or Microsoft.
A Mailbox OAuth App is the platform customer's own OAuth client at Google or Microsoft. End users consent to it, so the consent screen names the customer's app and never Sylphx, and every OAUTH mailbox of its provider in the environment refreshes its grant against it. An environment has at most one per provider.
Service Sylphx Notify · Resource type notify.sylphx.com/MailboxOauthApp · Name pattern orgs/{org}/projects/{project}/envs/{env}/mailbox_oauth_apps/{mailbox_oauth_app} · Shape spec_status
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/mailbox_oauth_apps/{mailbox_oauth_app}. |
uid | string | moa_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | MailboxOauthAppSpec | Desired state. Required. |
status | MailboxOauthAppStatus | Observed state. Output only. |
#Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a mailbox OAuth app. |
GET | list | Lists mailbox OAuth apps. |
POST | create | Creates a mailbox OAuth app. |
PATCH | update | Updates a mailbox OAuth app. |
DELETE | delete | Deletes a mailbox OAuth app; refused while a mailbox uses it. |
#get
Gets a mailbox OAuth app.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app · scope notify:read · effect read · Request, response and examples
#list
Lists mailbox OAuth apps.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps · scope notify:read · effect read · paginated · Request, response and examples
#create
Creates a mailbox OAuth app.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps · scope notify:write · effect write · Request, response and examples
#update
Updates a mailbox OAuth app.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app · scope notify:write · effect write · Request, response and examples
#delete
Deletes a mailbox OAuth app; refused while a mailbox uses it.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app · scope notify:write · effect destructive · Request, response and examples