Skip to main content

Settings

The settings API is a generic scoped key-value store. It has a simple setting query and a updateSetting mutation to manage settings.

The Setting Union currently only supports BooleanSetting.

Each BooleanSetting setting has the following fields:

  • code: A string for the setting code. A code can be used in multiple scopeTypes.
  • scope.scopeType: Defines the context of the code as a code can be used in multiple context. One of WORKSPACE_SLACK_NOTIFICATIONS, USER_SLACK_NOTIFICATIONS, USER_EMAIL_NOTIFICATIONS
  • scope.id (optional): depending on the scopeType this is either an entity ID or null
  • booleanValue: true/false, is the setting enabled or disabled

Scopes​

WORKSPACE_SLACK_NOTIFICATIONS​

Scope ID: Please provide a workspace slack integration.

Codes:

  • notification/slack/customer_status_transitioned_to_active
    • When a customer becomes active, i.e. waiting for help.
  • notification/slack/customer_status_transitioned_to_idle
    • When a customer becomes idle, i.e. marked as helped.
  • notification/slack/customer_assignment_transitioned
    • When a customer's assignment changes (assigned, reassigned, unassigned).

USER_SLACK_NOTIFICATIONS​

Scope ID: Not needed, leave as null or omit from payload. It will implicitly be scoped to the human user making the request. This also means that machine user can not query for any setting codes using this scope.

Codes:

  • notification/slack/customer_status_transitioned_to_active
    • When a customer becomes active, i.e. waiting for help.
  • notification/slack/customer_status_transitioned_to_idle
    • When a customer becomes idle, i.e. marked as helped.
  • notification/slack/customer_assignment_transitioned
    • When a customer's assignment changes (assigned, reassigned, unassigned).
  • notification/slack/customer_assigned_to_you/customer_status_transitioned_to_active
    • When a customer who is assigned to the user becomes active, i.e. waiting for help.
  • notification/slack/customer_assigned_to_you/customer_status_transitioned_to_idle
    • When a customer who is assigned to the user becomes idle, i.e. marked as helped.
  • notification/slack/customer_assigned_to_you/customer_assignment_transitioned
    • When a customer who is assigned to the user assignment changes (assigned, reassigned, unassigned).
  • notification/slack/customer_assigned_to_you/customer_email_received
    • When a customer who is assigned to the user sends an email.
  • notification/slack/customer_assigned_to_you/customer_chat_received
    • When a customer who is assigned to the user sends a chat.
  • notification/slack/customer_assigned_to_you/custom_timeline_entry_created
    • When a custom timeline entry is created for a customer who is assigned to the user.

USER_EMAIL_NOTIFICATIONS​

Scope ID: Not needed, leave null or omit from payload. It will implicitly be scoped to the human user making the request. This also means that machine user can not query for any setting codes using this scope.

Codes:

  • notification/email/customer_status_transitioned_to_active
    • When a customer becomes active, i.e. waiting for help.
  • notification/email/customer_assigned_to_you/customer_status_transitioned_to_active
    • When a customer who is assigned to the user becomes active, i.e. waiting for help.
  • notification/email/customer_assigned_to_you/custom_timeline_entry_created
    • When a custom timeline entry is created for a customer who is assigned to the user.