Restructure omni services and add Chatwoot research snapshot

research/chatwoot/swagger/definitions/request/account/create_update_payload.yml

@@ -0,0 +1,31 @@
+type: object
+properties:
+  name:
+    type: string
+    description: Name of the account
+    example: 'My Account'
+  locale:
+    type: string
+    description: The locale of the account
+    example: 'en'
+  domain:
+    type: string
+    description: The domain of the account
+    example: 'example.com'
+  support_email:
+    type: string
+    description: The support email of the account
+    example: 'support@example.com'
+  status:
+    type: string
+    enum: ['active', 'suspended']
+    description: The status of the account
+    example: 'active'
+  limits:
+    type: object
+    description: The limits of the account
+    example: {}
+  custom_attributes:
+    type: object
+    description: The custom attributes of the account
+    example: {}

research/chatwoot/swagger/definitions/request/account/update_payload.yml

@@ -0,0 +1,49 @@
+type: object
+properties:
+  name:
+    type: string
+    description: Name of the account
+    example: 'My Account'
+  locale:
+    type: string
+    description: The locale of the account
+    example: 'en'
+  domain:
+    type: string
+    description: The domain of the account
+    example: 'example.com'
+  support_email:
+    type: string
+    description: The support email of the account
+    example: 'support@example.com'
+  # Settings parameters (stored in settings JSONB column)
+  auto_resolve_after:
+    type: integer
+    minimum: 10
+    maximum: 1439856
+    nullable: true
+    description: Auto resolve conversations after specified minutes
+    example: 1440
+  auto_resolve_message:
+    type: string
+    nullable: true
+    description: Message to send when auto resolving
+    example: "This conversation has been automatically resolved due to inactivity"
+  auto_resolve_ignore_waiting:
+    type: boolean
+    nullable: true
+    description: Whether to ignore waiting conversations for auto resolve
+    example: false
+  # Custom attributes parameters (stored in custom_attributes JSONB column)
+  industry:
+    type: string
+    description: Industry type
+    example: "Technology"
+  company_size:
+    type: string
+    description: Company size
+    example: "50-100"
+  timezone:
+    type: string
+    description: Account timezone
+    example: "UTC"

research/chatwoot/swagger/definitions/request/account_user/create_update_payload.yml

@@ -0,0 +1,13 @@
+type: object
+required:
+  - user_id
+  - role
+properties:
+  user_id:
+    type: integer
+    description: The ID of the user
+    example: 1
+  role:
+    type: string
+    description: whether user is an administrator or agent
+    example: administrator

research/chatwoot/swagger/definitions/request/agent/create_payload.yml

@@ -0,0 +1,28 @@
+type: object
+required:
+  - name
+  - email
+  - role
+properties:
+  name:
+    type: string
+    description: Full Name of the agent
+    example: 'John Doe'
+  email:
+    type: string
+    description: Email of the Agent
+    example: 'john.doe@acme.inc'
+  role:
+    type: string
+    enum: ['agent', 'administrator']
+    description: Whether its administrator or agent
+    example: 'agent'
+  availability_status:
+    type: string
+    enum: ['available', 'busy', 'offline']
+    description: The availability setting of the agent.
+    example: 'available'
+  auto_offline:
+    type: boolean
+    description: Whether the availability status of agent is configured to go offline automatically when away.
+    example: true

research/chatwoot/swagger/definitions/request/agent/update_payload.yml

@@ -0,0 +1,18 @@
+type: object
+required:
+  - role
+properties:
+  role:
+    type: string
+    enum: ['agent', 'administrator']
+    description: Whether its administrator or agent
+    example: 'agent'
+  availability_status:
+    type: string
+    enum: ['available', 'busy', 'offline']
+    description: The availability status of the agent.
+    example: 'available'
+  auto_offline:
+    type: boolean
+    description: Whether the availability status of agent is configured to go offline automatically when away.
+    example: true

research/chatwoot/swagger/definitions/request/agent_bot/create_update_payload.yml

@@ -0,0 +1,30 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name of the agent bot
+    example: 'My Agent Bot'
+  description:
+    type: string
+    description: The description of the agent bot
+    example: 'This is a sample agent bot'
+  outgoing_url:
+    type: string
+    description: The webhook URL for the bot
+    example: 'https://example.com/webhook'
+  avatar:
+    type: string
+    format: binary
+    description: Send the form data with the avatar image binary or use the avatar_url
+  avatar_url:
+    type: string
+    description: The url to a jpeg, png file for the agent bot avatar
+    example: https://example.com/avatar.png
+  bot_type:
+    type: integer
+    description: The type of the bot (0 for webhook)
+    example: 0
+  bot_config:
+    type: object
+    description: The configuration for the bot
+    example: {}

research/chatwoot/swagger/definitions/request/automation_rule/create_update_payload.yml

@@ -0,0 +1,42 @@
+type: object
+properties:
+  name:
+    type: string
+    description: Rule name
+    example: Add label on message create event
+  description:
+    type: string
+    description: The description about the automation and actions
+    example: Add label support and sales on message create event if incoming message content contains text help
+  event_name:
+    type: string
+    enum:
+      - conversation_created
+      - conversation_updated
+      - conversation_resolved
+      - message_created
+    example: message_created
+    description: The event when you want to execute the automation actions
+  active:
+    type: boolean
+    description: Enable/disable automation rule
+  actions:
+    type: array
+    description: Array of actions which you want to perform when condition matches, e.g add label support if message contains content help.
+    items:
+      type: object
+      example:
+        action_name: add_label
+        action_params:
+          - support
+  conditions:
+    type: array
+    description: Array of conditions on which conversation filter would work, e.g message content contains text help.
+    items:
+      type: object
+      example:
+        attribute_key: content
+        filter_operator: contains
+        query_operator: OR
+        values:
+          - help

research/chatwoot/swagger/definitions/request/canned_response/create_update_payload.yml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  content:
+    type: string
+    description: Message content for canned response
+    example: 'Hello, {{contact.name}}! Welcome to our service.'
+  short_code:
+    type: string
+    description: Short Code for quick access of the canned response
+    example: 'welcome'

research/chatwoot/swagger/definitions/request/contact/create_payload.yml

@@ -0,0 +1,44 @@
+type: object
+required:
+  - inbox_id
+properties:
+  inbox_id:
+    type: number
+    description: ID of the inbox to which the contact belongs
+    example: 1
+  name:
+    type: string
+    description: name of the contact
+    example: Alice
+  email:
+    type: string
+    description: email of the contact
+    example: alice@acme.inc
+  blocked:
+    type: boolean
+    description: whether the contact is blocked or not
+    example: false
+  phone_number:
+    type: string
+    description: phone number of the contact
+    example: '+123456789'
+  avatar:
+    type: string
+    format: binary
+    description: Send the form data with the avatar image binary or use the avatar_url
+  avatar_url:
+    type: string
+    description: The url to a jpeg, png file for the contact avatar
+    example: https://example.com/avatar.png
+  identifier:
+    type: string
+    description: A unique identifier for the contact in external system
+    example: '1234567890'
+  additional_attributes:
+    type: object
+    description: An object where you can store additional attributes for contact. example {"type":"customer", "age":30}
+    example: { 'type': 'customer', 'age': 30 }
+  custom_attributes:
+    type: object
+    description: An object where you can store custom attributes for contact. example {"type":"customer", "age":30}, this should have a valid custom attribute definition.
+    example: {}

research/chatwoot/swagger/definitions/request/contact/update_payload.yml

@@ -0,0 +1,38 @@
+type: object
+properties:
+  name:
+    type: string
+    description: name of the contact
+    example: Alice
+  email:
+    type: string
+    description: email of the contact
+    example: alice@acme.inc
+  blocked:
+    type: boolean
+    description: whether the contact is blocked or not
+    example: false
+  phone_number:
+    type: string
+    description: phone number of the contact
+    example: '+123456789'
+  avatar:
+    type: string
+    format: binary
+    description: Send the form data with the avatar image binary or use the avatar_url
+  avatar_url:
+    type: string
+    description: The url to a jpeg, png file for the contact avatar
+    example: https://example.com/avatar.png
+  identifier:
+    type: string
+    description: A unique identifier for the contact in external system
+    example: '1234567890'
+  additional_attributes:
+    type: object
+    description: An object where you can store additional attributes for contact. example {"type":"customer", "age":30}
+    example: { 'type': 'customer', 'age': 30 }
+  custom_attributes:
+    type: object
+    description: An object where you can store custom attributes for contact. example {"type":"customer", "age":30}, this should have a valid custom attribute definition.
+    example: {}

research/chatwoot/swagger/definitions/request/conversation/create_message_payload.yml

@@ -0,0 +1,93 @@
+type: object
+required:
+  - content
+properties:
+  content:
+    type: string
+    description: The content of the message
+    example: 'Hello, how can I help you?'
+  message_type:
+    type: string
+    enum: ['outgoing', 'incoming']
+    description: The type of the message
+    example: 'outgoing'
+  private:
+    type: boolean
+    description: Flag to identify if it is a private note
+    example: false
+  content_type:
+    type: string
+    enum: ['text', 'input_email', 'cards', 'input_select', 'form', 'article']
+    description: Content type of the message
+    example: 'text'
+  content_attributes:
+    type: object
+    description: Attributes based on the content type
+    example: {}
+  campaign_id:
+    type: integer
+    description: The campaign id to which the message belongs
+    example: 1
+  template_params:
+    type: object
+    description: WhatsApp template parameters for sending structured messages
+    required:
+      - name
+      - category
+      - language
+      - processed_params
+    properties:
+      name:
+        type: string
+        description: Name of the WhatsApp template (must be approved in WhatsApp Business Manager)
+        example: 'purchase_receipt'
+      category:
+        type: string
+        enum: ['UTILITY', 'MARKETING', 'SHIPPING_UPDATE', 'TICKET_UPDATE', 'ISSUE_RESOLUTION']
+        description: Category of the template
+        example: 'UTILITY'
+      language:
+        type: string
+        description: Language code of the template (BCP 47 format)
+        example: 'en_US'
+      processed_params:
+        type: object
+        description: Processed template parameters organized by component type
+        properties:
+          body:
+            type: object
+            description: Body component parameters with variable placeholders
+            additionalProperties:
+              type: string
+            example:
+              '1': 'Visa'
+              '2': 'Nike'
+              '3': 'Bill'
+          header:
+            type: object
+            description: Header component parameters for media templates
+            properties:
+              media_url:
+                type: string
+                format: uri
+                description: Publicly accessible URL for IMAGE, VIDEO, or DOCUMENT headers
+                example: 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf'
+              media_type:
+                type: string
+                enum: ['image', 'video', 'document']
+                description: Type of media for the header
+                example: 'document'
+          buttons:
+            type: array
+            description: Button component parameters for interactive templates
+            items:
+              type: object
+              properties:
+                type:
+                  type: string
+                  enum: ['url', 'copy_code']
+                  description: Type of button parameter
+                parameter:
+                  type: string
+                  description: Dynamic parameter value for the button
+                  example: 'SSFSDFSD'

research/chatwoot/swagger/definitions/request/conversation/create_payload.yml

@@ -0,0 +1,79 @@
+type: object
+required:
+  - source_id
+  - inbox_id
+properties:
+  source_id:
+    type: string
+    description: Conversation source id
+    example: '1234567890'
+  inbox_id:
+    type: integer
+    description: 'Id of inbox in which the conversation is created <br/> Allowed Inbox Types: Website, Phone, Api, Email'
+    example: 1
+  contact_id:
+    type: integer
+    description: Contact Id for which conversation is created
+    example: 1
+  additional_attributes:
+    type: object
+    description: Lets you specify attributes like browser information
+    example:
+      {
+        browser: 'Chrome',
+        browser_version: '89.0.4389.82',
+        os: 'Windows',
+        os_version: '10',
+      }
+  custom_attributes:
+    type: object
+    description: The object to save custom attributes for conversation, accepts custom attributes key and value
+    example: { attribute_key: attribute_value, priority_conversation_number: 3 }
+  status:
+    type: string
+    enum: ['open', 'resolved', 'pending']
+    description: Specify the conversation whether it's pending, open, closed
+    example: open
+  assignee_id:
+    type: integer
+    description: Agent Id for assigning a conversation to an agent
+    example: 1
+  team_id:
+    type: integer
+    description: Team Id for assigning a conversation to a team\
+    example: 1
+  snoozed_until:
+    type: string
+    format: date-time
+    description: Snoozed until date time
+    example: '2030-07-21T17:32:28Z'
+  message:
+    type: object
+    description: The initial message to be sent to the conversation
+    required: ['content']
+    properties:
+      content:
+        type: string
+        description: The content of the message
+        example: 'Hello, how can I help you?'
+      template_params:
+        type: object
+        description: The template params for the message in case of whatsapp Channel
+        properties:
+          name:
+            type: string
+            description: Name of the template
+            example: 'sample_issue_resolution'
+          category:
+            type: string
+            description: Category of the template
+            example: UTILITY
+          language:
+            type: string
+            description: Language of the template
+            example: en_US
+          processed_params:
+            type: object
+            description: The processed param values for template variables in template
+            example:
+              1: 'Chatwoot'

research/chatwoot/swagger/definitions/request/custom_attribute/create_update_payload.yml

@@ -0,0 +1,36 @@
+type: object
+properties:
+  attribute_display_name:
+    type: string
+    description: Attribute display name
+    example: 'Custom Attribute'
+  attribute_display_type:
+    type: integer
+    description: Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)
+    example: 0
+  attribute_description:
+    type: string
+    description: Attribute description
+    example: 'This is a custom attribute'
+  attribute_key:
+    type: string
+    description: Attribute unique key value
+    example: 'custom_attribute'
+  attribute_values:
+    type: array
+    description: Attribute values
+    items:
+      type: string
+    example: ['value1', 'value2']
+  attribute_model:
+    type: integer
+    description: Attribute type(conversation_attribute- 0, contact_attribute- 1)
+    example: 0
+  regex_pattern:
+    type: string
+    description: Regex pattern (Only applicable for type- text). The regex pattern is used to validate the attribute value(s).
+    example: '^[a-zA-Z0-9]+$'
+  regex_cue:
+    type: string
+    description: Regex cue message (Only applicable for type- text). The cue message is shown when the regex pattern is not matched.
+    example: 'Please enter a valid value'

research/chatwoot/swagger/definitions/request/custom_filter/create_update_payload.yml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name of the custom filter
+    example: 'My Custom Filter'
+  type:
+    type: string
+    enum: ['conversation', 'contact', 'report']
+    description: The description about the custom filter
+    example: 'conversation'
+  query:
+    type: object
+    description: A query that needs to be saved as a custom filter
+    example: {}

research/chatwoot/swagger/definitions/request/inbox/create_payload.yml

@@ -0,0 +1,88 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name of the inbox
+    example: 'Support'
+  avatar:
+    type: string
+    format: binary
+    description: Image file for avatar
+  greeting_enabled:
+    type: boolean
+    description: Enable greeting message
+    example: true
+  greeting_message:
+    type: string
+    description: Greeting message to be displayed on the widget
+    example: Hello, how can I help you?
+  enable_email_collect:
+    type: boolean
+    description: Enable email collection
+    example: true
+  csat_survey_enabled:
+    type: boolean
+    description: Enable CSAT survey
+    example: true
+  enable_auto_assignment:
+    type: boolean
+    description: Enable Auto Assignment
+    example: true
+  working_hours_enabled:
+    type: boolean
+    description: Enable working hours
+    example: true
+  out_of_office_message:
+    type: string
+    description: Out of office message to be displayed on the widget
+    example: We are currently out of office. Please leave a message and we will get back to you.
+  timezone:
+    type: string
+    description: Timezone of the inbox
+    example: 'America/New_York'
+  allow_messages_after_resolved:
+    type: boolean
+    description: Allow messages after conversation is resolved
+    example: true
+  lock_to_single_conversation:
+    type: boolean
+    description: Lock to single conversation
+    example: true
+  portal_id:
+    type: integer
+    description: Id of the help center portal to attach to the inbox
+    example: 1
+  sender_name_type:
+    type: string
+    description: Sender name type for the inbox
+    enum: ['friendly', 'professional']
+    example: 'friendly'
+  business_name:
+    type: string
+    description: Business name for the inbox
+    example: 'My Business'
+  channel:
+    type: object
+    properties:
+      type:
+        type: string
+        description: Type of the channel
+        enum:
+          ['web_widget', 'api', 'email', 'line', 'telegram', 'whatsapp', 'sms']
+        example: web_widget
+      website_url:
+        type: string
+        description: URL at which the widget will be loaded
+        example: 'https://example.com'
+      welcome_title:
+        type: string
+        description: Welcome title to be displayed on the widget
+        example: 'Welcome to our support'
+      welcome_tagline:
+        type: string
+        description: Welcome tagline to be displayed on the widget
+        example: 'We are here to help you'
+      widget_color:
+        type: string
+        description: A Hex-color string used to customize the widget
+        example: '#FF5733'

research/chatwoot/swagger/definitions/request/inbox/update_payload.yml

@@ -0,0 +1,82 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name of the inbox
+    example: 'Support'
+  avatar:
+    type: string
+    format: binary
+    description: Image file for avatar
+  greeting_enabled:
+    type: boolean
+    description: Enable greeting message
+    example: true
+  greeting_message:
+    type: string
+    description: Greeting message to be displayed on the widget
+    example: Hello, how can I help you?
+  enable_email_collect:
+    type: boolean
+    description: Enable email collection
+    example: true
+  csat_survey_enabled:
+    type: boolean
+    description: Enable CSAT survey
+    example: true
+  enable_auto_assignment:
+    type: boolean
+    description: Enable Auto Assignment
+    example: true
+  working_hours_enabled:
+    type: boolean
+    description: Enable working hours
+    example: true
+  out_of_office_message:
+    type: string
+    description: Out of office message to be displayed on the widget
+    example: We are currently out of office. Please leave a message and we will get back to you.
+  timezone:
+    type: string
+    description: Timezone of the inbox
+    example: 'America/New_York'
+  allow_messages_after_resolved:
+    type: boolean
+    description: Allow messages after conversation is resolved
+    example: true
+  lock_to_single_conversation:
+    type: boolean
+    description: Lock to single conversation
+    example: true
+  portal_id:
+    type: integer
+    description: Id of the help center portal to attach to the inbox
+    example: 1
+  sender_name_type:
+    type: string
+    description: Sender name type for the inbox
+    enum: ['friendly', 'professional']
+    example: 'friendly'
+  business_name:
+    type: string
+    description: Business name for the inbox
+    example: 'My Business'
+  channel:
+    type: object
+    properties:
+      website_url:
+        type: string
+        description: URL at which the widget will be loaded
+        example: 'https://example.com'
+      welcome_title:
+        type: string
+        description: Welcome title to be displayed on the widget
+        example: 'Welcome to our support'
+      welcome_tagline:
+        type: string
+        description: Welcome tagline to be displayed on the widget
+        example: 'We are here to help you'
+      widget_color:
+        type: string
+        description: A Hex-color string used to customize the widget
+        example: '#FF5733'

research/chatwoot/swagger/definitions/request/integrations/hook_create_payload.yml

@@ -0,0 +1,18 @@
+type: object
+properties:
+  app_id:
+    type: integer
+    description: The ID of app for which integration hook is being created
+    example: 1
+  inbox_id:
+    type: integer
+    description: The inbox ID, if the hook is an inbox hook
+    example: 1
+  status:
+    type: integer
+    description: The status of the integration (0 for inactive, 1 for active)
+    example: 1
+  settings:
+    type: object
+    description: The settings required by the integration
+    example: {}

research/chatwoot/swagger/definitions/request/integrations/hook_update_payload.yml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  status:
+    type: integer
+    description: The status of the integration (0 for inactive, 1 for active)
+    example: 1
+  settings:
+    type: object
+    description: The settings required by the integration
+    example: {}

research/chatwoot/swagger/definitions/request/platform/agent_bot/create_update_payload.yml

@@ -0,0 +1,26 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name of the agent bot
+    example: 'My Agent Bot'
+  description:
+    type: string
+    description: The description of the agent bot
+    example: 'This is a sample agent bot'
+  outgoing_url:
+    type: string
+    description: The webhook URL for the bot
+    example: 'https://example.com/webhook'
+  account_id:
+    type: integer
+    description: The account ID to associate the agent bot with
+    example: 1
+  avatar:
+    type: string
+    format: binary
+    description: Send the form data with the avatar image binary or use the avatar_url
+  avatar_url:
+    type: string
+    description: The url to a jpeg, png file for the agent bot avatar
+    example: https://example.com/avatar.png

research/chatwoot/swagger/definitions/request/portal/article_create_update_payload.yml

@@ -0,0 +1,51 @@
+type: object
+properties:
+  title:
+    type: string
+    description: The title of the article
+    example: 'Article Title'
+  slug:
+    type: string
+    description: The slug of the article
+    example: 'article-title'
+  position:
+    type: integer
+    description: article position in category
+    example: 1
+  content:
+    type: string
+    description: The text content.
+    example: 'This is the content of the article'
+  description:
+    type: string
+    description: The description of the article
+    example: 'This is the description of the article'
+  category_id:
+    type: integer
+    description: The category id of the article
+    example: 1
+  author_id:
+    type: integer
+    description: The author agent id of the article
+    example: 1
+  associated_article_id:
+    type: integer
+    description: To associate similar articles to each other, e.g to provide the link for the reference.
+    example: 2
+  status:
+    type: integer
+    description: The status of the article. 0 for draft, 1 for published, 2 for archived
+    example: 1
+  locale:
+    type: string
+    description: The locale of the article
+    example: 'en'
+  meta:
+    type: object
+    description: Use for search
+    example:
+      {
+        tags: ['article_name'],
+        title: 'article title',
+        description: 'article description',
+      }

research/chatwoot/swagger/definitions/request/portal/category_create_update_payload.yml

@@ -0,0 +1,34 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name of the category
+    example: 'Category Name'
+  description:
+    type: string
+    description: A description for the category
+    example: 'Category description'
+  position:
+    type: integer
+    description: Category position in the portal list to sort
+    example: 1
+  slug:
+    type: string
+    description: The category slug used in the URL
+    example: 'category-name'
+  locale:
+    type: string
+    description: The locale of the category
+    example: en
+  icon:
+    type: string
+    description: The icon of the category as a string (emoji)
+    example: '📚'
+  parent_category_id:
+    type: integer
+    description: To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.
+    example: 1
+  associated_category_id:
+    type: integer
+    description: To associate similar categories to each other, e.g same category of product documentation in different languages
+    example: 2

research/chatwoot/swagger/definitions/request/portal/portal_create_update_payload.yml

@@ -0,0 +1,38 @@
+type: object
+properties:
+  color:
+    type: string
+    description: Header color for help-center in hex format
+    example: '#FFFFFF'
+  custom_domain:
+    type: string
+    description: Custom domain to display help center.
+    example: chatwoot.help
+  header_text:
+    type: string
+    description: Help center header
+    example: Handbook
+  homepage_link:
+    type: string
+    description: link to main dashboard
+    example: https://www.chatwoot.com/
+  name:
+    type: string
+    description: Name for the portal
+    example: Handbook
+  page_title:
+    type: string
+    description: Page title for the portal
+    example: Handbook
+  slug:
+    type: string
+    description: Slug for the portal to display in link
+    example: handbook
+  archived:
+    type: boolean
+    description: Status to check if portal is live
+    example: false
+  config:
+    type: object
+    description: Configuration about supporting locales
+    example: { allowed_locales: ['en', 'es'], default_locale: 'en' }

research/chatwoot/swagger/definitions/request/public/contact/create_update_payload.yml

@@ -0,0 +1,30 @@
+type: object
+properties:
+  identifier:
+    type: string
+    description: External identifier of the contact
+    example: '1234567890'
+  identifier_hash:
+    type: string
+    description: Identifier hash prepared for HMAC authentication
+    example: 'e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9'
+  email:
+    type: string
+    description: Email of the contact
+    example: alice@acme.inc
+  name:
+    type: string
+    description: Name of the contact
+    example: Alice
+  phone_number:
+    type: string
+    description: Phone number of the contact
+    example: '+123456789'
+  avatar:
+    type: string
+    format: binary
+    description: Send the form data with the avatar image binary or use the avatar_url
+  custom_attributes:
+    type: object
+    description: Custom attributes of the customer
+    example: {}

research/chatwoot/swagger/definitions/request/public/conversation/create_payload.yml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  custom_attributes:
+    type: object
+    description: Custom attributes of the conversation
+    example: {}

research/chatwoot/swagger/definitions/request/public/message/create_payload.yml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  content:
+    type: string
+    description: Content for the message
+    example: 'Hello, how can I help you?'
+  echo_id:
+    type: string
+    description: Temporary identifier which will be passed back via websockets
+    example: '1234567890'

research/chatwoot/swagger/definitions/request/public/message/update_payload.yml

@@ -0,0 +1,30 @@
+type: object
+properties:
+  submitted_values:
+    type: object
+    description: Replies to the Bot Message Types
+    properties:
+      name:
+        type: string
+        description: The name of the submiitted value
+        example: 'My Name'
+      title:
+        type: string
+        description: The title of the submitted value
+        example: 'My Title'
+      value:
+        type: string
+        description: The value of the submitted value
+        example: 'value'
+      csat_survey_response:
+        type: object
+        description: The CSAT survey response
+        properties:
+          feedback_message:
+            type: string
+            description: The feedback message of the CSAT survey response
+            example: 'Great service!'
+          rating:
+            type: integer
+            description: The rating of the CSAT survey response
+            example: 5

research/chatwoot/swagger/definitions/request/team/create_update_payload.yml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name of the team
+    example: Support Team
+  description:
+    type: string
+    description: The description of the team
+    example: This is a team of support agents
+  allow_auto_assign:
+    type: boolean
+    description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team
+    example: true

research/chatwoot/swagger/definitions/request/user/create_update_payload.yml

@@ -0,0 +1,22 @@
+type: object
+properties:
+  name:
+    type: string
+    description: Name of the user
+    example: 'Daniel'
+  display_name:
+    type: string
+    description: Display name of the user
+    example: 'Dan'
+  email:
+    type: string
+    description: Email of the user
+    example: 'daniel@acme.inc'
+  password:
+    type: string
+    description: Password must contain uppercase, lowercase letters, number and a special character
+    example: 'Password2!'
+  custom_attributes:
+    type: object
+    description: Custom attributes you want to associate with the user
+    example: {}

research/chatwoot/swagger/definitions/request/webhooks/create_update_payload.yml

@@ -0,0 +1,28 @@
+type: object
+properties:
+  url:
+    type: string
+    description: The url where the events should be sent
+    example: https://example.com/webhook
+  name:
+    type: string
+    description: The name of the webhook
+  subscriptions:
+    type: array
+    items:
+      type: string
+      enum:
+        [
+          'conversation_created',
+          'conversation_status_changed',
+          'conversation_updated',
+          'message_created',
+          'message_updated',
+          'contact_created',
+          'contact_updated',
+          'webwidget_triggered',
+        ]
+    description: The events you want to subscribe to.
+    example:
+      - conversation_created
+      - conversation_status_changed