/tickets/settings/notifications/channels

PUT /tickets/settings/notifications/channels

Update notification channels

Configure notification channels for ticket events

Request Body

Minimum Required
All Properties

{}

{
  "channels": [
    {
      "type": "string",
      "enabled": false,
      "webhookUrl": "string",
      "fromEmail": "string",
      "smsProvider": "string"
    }
  ]
}

Try it out

Output:

Responses

Description

Notification channels updated successfully

{
  "success": false,
  "message": "string"
}

References

#/components/schemas/NotificationChannel

OpenAPI
TypeScript

type: object
required:
  - type
  - enabled
properties:
  type:
    type: string
    enum:
      - email
      - sms
      - slack
      - in_app
    description: Channel type
  enabled:
    type: boolean
    description: Whether channel is enabled
  webhookUrl:
    type: string
    description: Webhook URL (for slack)
  fromEmail:
    type: string
    description: From email address (for email)
  smsProvider:
    type: string
    description: SMS provider (for sms)

|
export interface NotificationChannel {
  /** Channel type */
  type: "email" | "sms" | "slack" | "in_app";
  /** Whether channel is enabled */
  enabled: boolean;
  /** Webhook URL (for slack) */
  webhookUrl?: string;
  /** From email address (for email) */
  fromEmail?: string;
  /** SMS provider (for sms) */
  smsProvider?: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /tickets/settings/notifications/channels/route.ts

Or the swagger.yaml spec this documentation was generated from: /tickets/settings/swagger.yaml