Skip to content

Workspace Settings

Workspace settings control the general configuration for your Synapse account, including company information, timezone, and default email sender details.


Who Can Access

Workspace settings can be modified by users with the Owner, Admin, or Developer role. Other roles cannot change these settings.


Company Information

  1. Go to Settings > Workspace in the dashboard sidebar.
  2. Update the following fields:
FieldDescriptionExample
Company NameYour organization's nameAcme Corp
IndustryYour industry verticalInsurance, E-commerce, SaaS
Company SizeApproximate team or company size1-10, 11-50, 51-200, 200+
CountryPrimary country of operationSingapore
TimezoneUsed for scheduling and analytics date displayAsia/Singapore
  1. Click Save to apply changes.
Tip

Setting the correct timezone is important. It affects how dates are displayed in analytics dashboards and when scheduled tasks (like monthly email counter resets) run for your workspace.


Default Sender

The default sender settings control the "from" address used when a template doesn't specify its own sender:

FieldDescriptionExample
Default From NameThe display name recipients seeAcme Notifications
Default From EmailThe email address shown as the sender[email protected]
Note

The "Default From Email" sends from a verified domain. If you haven't set up your own custom domain, leave this on the shared Synapse domain ([email protected]) — it's verified out of the box and works in both test and live mode, so you can go live without any domain setup. Adding your own domain is an optional upgrade. See Set Up Sender Domain.


Workspace ID

Your Workspace ID is a unique identifier for your workspace. It's displayed on the Settings page and is used by your development team when configuring API integrations.

  • The Workspace ID is set during onboarding and cannot be changed.
  • You can copy it using the Copy button next to the ID.
  • API requests include this ID in the X-WORKSPACE-ID header.

API Keys

API keys are managed in Settings > API Keys and are used by your application to send events and interact with the Synapse API.

FieldDescription
Key NameA label to help identify the key's purpose
ScopeWhat the key can do: data (send events), reporting (read analytics), management (manage resources), or full (all)
Environmentlive (production) or test (sandbox, emails logged but not sent)

Only Owner, Admin, and Developer roles can create and manage API keys.

Warning

API keys are shown only once when created. Store them securely. If a key is compromised, revoke it immediately from the API Keys page and create a new one.


Sender Domains

Sender domains are managed in Settings > Sender Domains. This is where you add, verify, and manage the domains used for sending emails. See Set Up Sender Domain for a complete setup guide.


Audit Log

The audit log (available to Owner and Admin roles) records significant actions taken in the workspace:

What's LoggedExample
Member invited or removed"Admin invited [email protected] as Marketing"
Role changed"Owner changed [email protected] from Viewer to Developer"
Flow activated or paused"Admin activated flow 'Welcome Email'"
API key created or revoked"Developer created API key 'Production Events'"
Settings changed"Admin updated default sender to [email protected]"

Use the audit log to track who made changes and when, which is helpful for compliance and troubleshooting.


Workspace Deletion

Warning

Workspace deletion is permanent and can only be done by the Owner.

If you need to delete your workspace:

  1. Go to Settings > Workspace.
  2. Scroll to the bottom and click Delete Workspace.
  3. Confirm by typing your Workspace ID.
  4. Enter your password for verification.

After deletion:

  • Active subscriptions are cancelled.
  • A 30-day grace period begins during which data is preserved but the workspace is inaccessible.
  • After 30 days, all data is permanently deleted.
  • Contact support within the grace period if you need to reverse the deletion.