Customize your experience by managing your individual user preferences and notification settings. Keeping your profile up to date ensures you receive the right alerts and interact with the platform exactly how you prefer.
User Preferences
Your user preferences control how the platform looks and behaves for your specific account. These settings are unique to you and do not affect other members of your organization.
Common preferences include dashboard layouts, default views, timezone configurations, and language selections.
- 1
View current preferences
Review your active settings to see what is currently configured for your account. You can view a single specific preference.
- 2
Set or update a preference
Apply a new value to a specific setting. If the preference doesn't exist yet, it will be created; if it does, the existing value will be overwritten.
- 3
Delete a preference
Remove a custom preference to revert that specific setting back to the platform's default behavior.
We recommend keeping your timezone and language preferences updated to ensure timestamps and automated reports are accurate for your location.
Push Notifications
Stay informed about important updates, alerts, and system events by subscribing to push notifications. You can tailor your subscriptions so you only receive alerts for the events that matter most to you.
Subscription Types
You can subscribe to notifications at two different levels:
Event-based subscriptions: Receive alerts for specific system events (e.g., when a specific task completes or fails).
Organization-wide subscriptions: Receive broader alerts that affect your entire organization (e.g., billing updates or organization-level security alerts).
flowchart LR
A["System Event Occurs"] --> B{"Is user subscribed?"}
B -- "Yes (Event or Org level)" --> C["Push Notification Delivered"]
B -- "No" --> D["Event Ignored"]Push notifications require active permissions in your web browser or mobile device. If you have subscribed but aren't receiving alerts, check your device's notification settings.
Developer Reference: API Endpoints
If you are building a custom integration or managing users programmatically, you can interact with user settings directly through our API.
Preferences API
Use the following endpoints to manage key-value user preferences:
| Action | Method | Endpoint | Description |
|---|---|---|---|
| Get one | GET | /preference | Retrieves the value of a single, specific preference. |
| Set | PUT | /preference | Creates or updates a specific user preference. |
| Delete | DELETE | /preference | Removes a preference, reverting to system defaults. |
Example: Setting a preference
curl -X PUT "https://api.gitdocai.com/preference"
-H "Authorization: Bearer YOUR_TOKEN"
-H "Content-Type: application/json"
-d '{"key": "theme", "value": "dark"}'Push Notifications API
Manage push notification opt-ins using these endpoints:
| Action | Method | Endpoint |
|---|---|---|
| Event Subscription | POST | /v1/event/push-notification-subscribe |
| Organization Subscription | POST | /v1/organizations/{organization_id}/push/subscribe |
What is the difference between the two subscription endpoints?
The /v1/event/push-notification-subscribe endpoint is a simplified route used to quickly opt a user into specific, isolated event alerts. The organization-level endpoint (/v1/organizations/{organization_id}/push/subscribe) is scoped to a specific tenant, ensuring the user receives notifications relevant to that particular organization's activity.
Can I subscribe a user to multiple organizations?
Yes. If a user belongs to multiple organizations, you must make a separate POST request to the organization subscription endpoint for each organization_id they wish to receive alerts from.