Event-Details

s.change


type	scope	deletable	ephemeral	annotatable
s.change	Global	❌	✔️	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.change payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "relationship": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "type"
  ]
}

s.delete


type	scope	deletable	ephemeral	annotatable
s.delete	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{}

s.form


type	scope	deletable	ephemeral	annotatable
s.form	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.form payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "formId": {
      "type": "string",
      "minLength": 1
    },
    "inline": {
      "type": "boolean"
    }
  },
  "required": [
    "formId"
  ]
}

s.form.submission


type	scope	deletable	ephemeral	annotatable
s.form.submission	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{}

s.invitation


type	scope	deletable	ephemeral	annotatable
s.invitation	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.invitation payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "roomId": {
      "type": "string"
    },
    "inviterId": {
      "type": "string"
    }
  },
  "required": [
    "roomId",
    "inviterId"
  ]
}

s.mention


type	scope	deletable	ephemeral	annotatable
s.mention	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.mention payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "eventId": {
      "type": "string"
    }
  },
  "required": [
    "eventId"
  ]
}

s.message.action


type	scope	deletable	ephemeral	annotatable
s.message.action	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.action payload",
  "type": "object",
  "required": [
    "writeable",
    "body",
    "type"
  ],
  "allOf": [
    {
      "$ref": "#/definitions/message-action"
    }
  ],
  "oneOf": [
    {
      "$ref": "#/definitions/simple-action"
    },
    {
      "$ref": "#/definitions/select-action"
    }
  ],
  "definitions": {
    "message-action": {
      "properties": {
        "action": {
          "type": "string"
        },
        "writeable": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string"
          }
        },
        "label": {
          "type": "string"
        },
        "body": {
          "type": "string"
        },
        "format": {
          "$ref": "#/definitions/format"
        },
        "repeatable": {
          "type": "boolean"
        },
        "required": {
          "type": "boolean"
        }
      }
    },
    "simple-action": {
      "oneOf": [
        {
          "$ref": "#/definitions/simple-string-action"
        },
        {
          "$ref": "#/definitions/simple-date-action"
        }
      ]
    },
    "select-action": {
      "oneOf": [
        {
          "$ref": "#/definitions/select-boolean-action"
        },
        {
          "$ref": "#/definitions/generic-select-action"
        },
        {
          "$ref": "#/definitions/select-select-action"
        }
      ]
    },
    "simple-string-action": {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "text",
            "textarea",
            "email"
          ]
        }
      }
    },
    "simple-date-action": {
      "required": [
        "type",
        "min",
        "max"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "date"
          ]
        },
        "min": {
          "type": "string",
          "format": "date-time"
        },
        "max": {
          "type": "string",
          "format": "date-time"
        },
        "center": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      }
    },
    "action-option": {
      "required": [
        "label",
        "value"
      ],
      "properties": {
        "value": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "url": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "select-boolean-action": {
      "required": [
        "options"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "boolean"
          ]
        },
        "options": {
          "type": "array",
          "minItems": 2,
          "maxItems": 2,
          "additionalItems": false,
          "oneOf": [
            {
              "$ref": "#/definitions/true-false-option"
            },
            {
              "$ref": "#/definitions/false-true-option"
            }
          ]
        }
      }
    },
    "true-false-option": {
      "x-intellij-html-description": "helper schema to circument json-schema shortcomings",
      "items": [
        {
          "required": [
            "label",
            "value"
          ],
          "properties": {
            "label": {
              "type": "string"
            },
            "value": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        },
        {
          "required": [
            "label",
            "value"
          ],
          "properties": {
            "label": {
              "type": "string"
            },
            "value": {
              "type": "string",
              "enum": [
                "false"
              ]
            }
          }
        }
      ]
    },
    "false-true-option": {
      "x-intellij-html-description": "helper schema to circument json-schema shortcomings",
      "items": [
        {
          "required": [
            "label",
            "value"
          ],
          "properties": {
            "label": {
              "type": "string"
            },
            "value": {
              "type": "string",
              "enum": [
                "false"
              ]
            }
          }
        },
        {
          "required": [
            "label",
            "value"
          ],
          "properties": {
            "label": {
              "type": "string"
            },
            "value": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        }
      ]
    },
    "generic-select-action": {
      "required": [
        "options"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "button",
            "link"
          ]
        },
        "options": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "#/definitions/action-option"
          }
        }
      }
    },
    "select-select-action": {
      "required": [
        "options",
        "multiple"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "select"
          ]
        },
        "multiple": {
          "type": "boolean"
        },
        "options": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "#/definitions/action-option"
          }
        }
      }
    },
    "format": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "enum": [
            "text/plain",
            "text/html"
          ]
        },
        {
          "type": "null"
        }
      ]
    }
  }
}

s.message.action.invocation


type	scope	deletable	ephemeral	annotatable
s.message.action.invocation	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.action invocation payload",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "value"
  ],
  "properties": {
    "value": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "label": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

s.message.action.invocation.validation


type	scope	deletable	ephemeral	annotatable
s.message.action.invocation.validation	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.action invocation validation payload",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "string",
      "enum": [
        "SUCCESS",
        "FAILURE"
      ]
    },
    "reason": {
      "type": "string"
    }
  }
}

s.message.edit


type	scope	deletable	ephemeral	annotatable
s.message.edit	Room	❌	❌	✔️

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.edit payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "editedType": {
      "type": "string",
      "enum": [
        "s.message.media",
        "s.message.text"
      ]
    },
    "body": {
      "type": "string"
    },
    "annotations": {
      "$ref": "resource:/schema/annotations.json"
    }
  },
  "required": [
    "body"
  ]
}

s.message.media


type	scope	deletable	ephemeral	annotatable
s.message.media	Room	✔️	❌	✔️

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.media payload",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "label": {
      "type": "string"
    },
    "body": {
      "type": "string"
    },
    "mediaId": {
      "type": "string"
    },
    "annotations": {
      "$ref": "resource:/schema/annotations.json"
    }
  },
  "oneOf": [
    {
      "required": [
        "label",
        "mediaId"
      ]
    },
    {
      "required": [
        "body",
        "mediaId"
      ]
    }
  ]
}

s.message.preview


type	scope	deletable	ephemeral	annotatable
s.message.preview	Room	❌️	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.preview payload",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "title": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "author": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "image": {
      "type": "string"
    },
    "fileId": {
      "type": "string"
    }
  },
  "required": [
    "url"
  ]
}

s.message.preview.track


type	scope	deletable	ephemeral	annotatable
s.message.preview.track	Room	❌️	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.preview.track payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {}
}

s.message.text


type	scope	deletable	ephemeral	annotatable
s.message.text	Room	✔	❌	✔

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.text payload",
  "type": "object",
  "required": [
    "body"
  ],
  "additionalProperties": true,
  "properties": {
    "body": {
      "type": "string"
    },
    "format": {
      "type": "string",
      "maxLength": 100
    },
    "annotations": {
      "$ref": "resource:/schema/annotations.json"
    }
  }
}

s.message.text.translation


type	scope	deletable	ephemeral	annotatable
s.message.text.translation	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.message.text.translation payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "body": {
      "type": "string"
    },
    "format": {
      "type": "string",
      "maxLength": 100
    },
    "sourceLanguage": {
      "type": "string",
      "maxLength": 2
    },
    "targetLanguage": {
      "type": "string",
      "maxLength": 2
    }
  },
  "required": [
    "body",
    "sourceLanguage",
    "targetLanguage"
  ]
}

s.presence


type	scope	deletable	ephemeral	annotatable
s.presence	Global	❌	✔	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.presence payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "OFFLINE",
        "INVISIBLE",
        "INACTIVE",
        "AWAY",
        "ONLINE"
      ]
    }
  },
  "required": [
    "status"
  ]
}

s.receipt


type	scope	deletable	ephemeral	annotatable
s.receipt	Room	❌	✔	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.receipt payload",
  "type": "object",
  "additionalProperties": false
}

s.room.blocked


type	scope	deletable	ephemeral	annotatable
s.room.blocked	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.room.blocked payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

s.room.close


type	scope	deletable	ephemeral	annotatable
s.room.close	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.room.close payload",
  "type": "object",
  "additionalProperties": false
}

s.room.create


type	scope	deletable	ephemeral	annotatable
s.room.create	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.room.create payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "creatorId": {
      "type": "string"
    }
  },
  "required": [
    "creatorId"
  ]
}

s.room.membership


type	scope	deletable	ephemeral	annotatable
s.room.membership	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.room.membership payload",
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/definitions/membershipJoin"
    },
    {
      "$ref": "#/definitions/membershipLeave"
    },
    {
      "$ref": "#/definitions/membershipInvite"
    }
  ],
  "required": [
    "membership"
  ],
  "definitions": {
    "membershipJoin": {
      "additionalProperties": false,
      "properties": {
        "membership": {
          "enum": [
            "join"
          ]
        },
        "initiatorId": {
          "type": "string"
        },
        "sticky": {
          "type": "boolean"
        },
        "assignee": {
          "enum": [
            "Agent",
            "Bot"
          ]
        },
        "trigger": {
          "enum": [
            "Auto",
            "Manual"
          ]
        }
      }
    },
    "membershipLeave": {
      "additionalProperties": false,
      "properties": {
        "membership": {
          "enum": [
            "leave"
          ]
        },
        "assignee": {
          "enum": [
            "Agent",
            "Bot"
          ]
        },
        "trigger": {
          "enum": [
            "Auto",
            "Manual"
          ]
        }
      }
    },
    "membershipInvite": {
      "additionalProperties": false,
      "properties": {
        "membership": {
          "enum": [
            "invite"
          ]
        },
        "inviteeId": {
          "type": "string"
        }
      },
      "required": [
        "inviteeId"
      ]
    }
  }
}

s.room.pin


type	scope	deletable	ephemeral	annotatable
s.room.pin	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.room.pin payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

s.room.setting


type	scope	deletable	ephemeral	annotatable
s.room.setting	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.room.settings payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

s.room.typing


type	scope	deletable	ephemeral	annotatable
s.room.typing	Room	❌	✔	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.room.typing payload",
  "type": "object",
  "additionalProperties": false
}

s.room.user.setting


type	scope	deletable	ephemeral	annotatable
s.room.user.setting	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.room.user.settings payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

s.support.close


type	scope	deletable	ephemeral	annotatable
s.support.close	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.support.close payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "trigger": {
      "enum": [
        "Auto",
        "Manual"
      ]
    }
  }
}

s.support.delegate


type	scope	deletable	ephemeral	annotatable
s.support.delegate	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.support.delegate payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "agentId": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1
    },
    "type": {
      "enum": [
        "Agent",
        "CRM"
      ]
    }
  },
  "required": [
    "type"
  ]
}

s.support.inactive


type	scope	deletable	ephemeral	annotatable
s.support.inactive	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.support.inactive payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {}
}

s.support.open


type	scope	deletable	ephemeral	annotatable
s.support.open	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{}

s.support.request


type	scope	deletable	ephemeral	annotatable
s.support.request	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.support.request payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "liveChatId": {
      "type": "string"
    },
    "preconditions": {
      "type": "object"
    }
  },
  "required": [
    "liveChatId"
  ]
}

s.support.request.rejected


type	scope	deletable	ephemeral	annotatable
s.support.request.rejected	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.support.request.rejected payload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "reason": {
      "enum": [
        "NO_OPERATOR_AVAILABLE",
        "OUTSIDE_BUSINESS_HOURS",
        "SERVER_ERROR"
      ]
    }
  },
  "required": [
    "reason"
  ]
}

s.timer


type	scope	deletable	ephemeral	annotatable
s.timer	Room	❌	❌	❌

Content schema

JSON Schema to validate this events content.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "s.timer payload",
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/definitions/create"
    },
    {
      "$ref": "#/definitions/update"
    }
  ],
  "definitions": {
    "create": {
      "additionalProperties": false,
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "RUNNING"
          ]
        },
        "expires": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "expires",
        "status"
      ]
    },
    "update": {
      "additionalProperties": false,
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "CANCELLED",
            "EXPIRED"
          ]
        }
      },
      "required": [
        "status"
      ]
    }
  }
}