Reference
Web API
Messages

Messages

The Messages API supports managing chat messages.

Create message

Creates a new message in the specified app (chat or conversation).

POST /api/apps/{app}/messages

Path parameters

app string required: App identifier (id or uid).

Body parameters

blobs array of integers: Ids of blobs to attach.

embed_id integer: Id of embed to attach.

meeting_id integer: Id of meeting to attach.

options array of objects: List of poll options to attach.

text string: The message text.

metadata object: Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

tags array of strings: A list of tags to associate with the item.

Example request

curl https://{WEAVY-SERVER}/api/apps/acme-chat/messages
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"
--json "{ 'text': 'This is a message' }"

Response codes

201 Created
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
422 Validation Failed

Response schema

{
  "id": "integer",
  "app_id": "integer",
  "parent": {
    "id": "integer",
    "type": "string"
  },
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    {
      "id": "integer",
      "app_id": "integer",
      "version": "integer",
      "name": "string",
      "kind": "string",
      "media_type": "string",
      "width": "integer",
      "height": "integer",
      "size": "integer",
      "metadata": "object",
      "tags": [
        "string"
      ],
      "provider": "string",
      "raw": "string",
      "download_url": "string",
      "application_url": "string",
      "embed_url": "string",
      "external_url": "string",
      "preview_format": "string",
      "preview_url": "string",
      "thumbnail_url": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "modified_at": "string",
      "modified_by_id": "integer",
      "comment_count": "integer",
      "comments": [
        "object"
      ],
      "is_subscribed": "boolean",
      "is_trashed": "boolean"
    }
  ],
  "embed_id": "integer",
  "embed": {
    "id": "integer",
    "description": "string",
    "created_at": "string",
    "created_by_id": "integer",
    "host": "string",
    "original_url": "string",
    "is_link": "boolean",
    "type": "string",
    "version": "string",
    "title": "string",
    "author_name": "string",
    "author_url": "string",
    "provider_name": "string",
    "provider_url": "string",
    "cache_age": "integer",
    "thumbnail_url": "string",
    "thumbnail_width": "integer",
    "thumbnail_height": "integer",
    "url": "string",
    "width": "integer",
    "height": "integer",
    "html": "string"
  },
  "meeting_id": "integer",
  "meeting": {
    "id": "integer",
    "provider": "string",
    "provider_id": "string",
    "uuid": "string",
    "join_url": "string",
    "ended_at": "string",
    "recording_url": "string"
  },
  "option_count": "integer",
  "options": [
    {
      "id": "integer",
      "text": "string",
      "vote_count": "integer",
      "has_voted": "boolean",
      "voters": [
        "object"
      ]
    }
  ],
  "reactions": [
    {
      "id": "integer",
      "content": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "count": "integer"
    }
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "created_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "modified_at": "string",
  "modified_by_id": "integer",
  "modified_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "is_trashed": "boolean"
}

Get message

Gets a message by id.

GET /api/messages/{id}

Path parameters

id integer required: Id of the message.

Query parameters

trashed boolean: true to return message even if trashed.

Example request

curl https://{WEAVY-SERVER}/api/messages/1
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Response codes

200 Success
401 Unauthorized
404 Not Found

Response schema

{
  "id": "integer",
  "app_id": "integer",
  "parent": {
    "id": "integer",
    "type": "string"
  },
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    {
      "id": "integer",
      "app_id": "integer",
      "version": "integer",
      "name": "string",
      "kind": "string",
      "media_type": "string",
      "width": "integer",
      "height": "integer",
      "size": "integer",
      "metadata": "object",
      "tags": [
        "string"
      ],
      "provider": "string",
      "raw": "string",
      "download_url": "string",
      "application_url": "string",
      "embed_url": "string",
      "external_url": "string",
      "preview_format": "string",
      "preview_url": "string",
      "thumbnail_url": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "modified_at": "string",
      "modified_by_id": "integer",
      "comment_count": "integer",
      "comments": [
        "object"
      ],
      "is_subscribed": "boolean",
      "is_trashed": "boolean"
    }
  ],
  "embed_id": "integer",
  "embed": {
    "id": "integer",
    "description": "string",
    "created_at": "string",
    "created_by_id": "integer",
    "host": "string",
    "original_url": "string",
    "is_link": "boolean",
    "type": "string",
    "version": "string",
    "title": "string",
    "author_name": "string",
    "author_url": "string",
    "provider_name": "string",
    "provider_url": "string",
    "cache_age": "integer",
    "thumbnail_url": "string",
    "thumbnail_width": "integer",
    "thumbnail_height": "integer",
    "url": "string",
    "width": "integer",
    "height": "integer",
    "html": "string"
  },
  "meeting_id": "integer",
  "meeting": {
    "id": "integer",
    "provider": "string",
    "provider_id": "string",
    "uuid": "string",
    "join_url": "string",
    "ended_at": "string",
    "recording_url": "string"
  },
  "option_count": "integer",
  "options": [
    {
      "id": "integer",
      "text": "string",
      "vote_count": "integer",
      "has_voted": "boolean",
      "voters": [
        "object"
      ]
    }
  ],
  "reactions": [
    {
      "id": "integer",
      "content": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "count": "integer"
    }
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "created_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "modified_at": "string",
  "modified_by_id": "integer",
  "modified_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "is_trashed": "boolean"
}

Update message

Updates a message.

PATCH /api/messages/{id}

Path parameters

id integer required: Id of the message.

Body parameters

attachments array of integers: Ids of attached files.

blobs array of integers: Ids of additional blobs to attach.

embed_id integer: Id of embed to attach.

meeting_id integer: Id of meeting to attach.

options array of objects: List of poll options for the item.

text string: The message text.

metadata object: Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

tags array of strings: A list of tags to associate with the item.

Example request

curl -X PATCH https://{WEAVY_SERVER}/api/messages/1
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"
--json "{ 'text': 'This is an updated message' }"

Response codes

200 Success
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
422 Validation Failed

Response schema

{
  "id": "integer",
  "app_id": "integer",
  "parent": {
    "id": "integer",
    "type": "string"
  },
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    {
      "id": "integer",
      "app_id": "integer",
      "version": "integer",
      "name": "string",
      "kind": "string",
      "media_type": "string",
      "width": "integer",
      "height": "integer",
      "size": "integer",
      "metadata": "object",
      "tags": [
        "string"
      ],
      "provider": "string",
      "raw": "string",
      "download_url": "string",
      "application_url": "string",
      "embed_url": "string",
      "external_url": "string",
      "preview_format": "string",
      "preview_url": "string",
      "thumbnail_url": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "modified_at": "string",
      "modified_by_id": "integer",
      "comment_count": "integer",
      "comments": [
        "object"
      ],
      "is_subscribed": "boolean",
      "is_trashed": "boolean"
    }
  ],
  "embed_id": "integer",
  "embed": {
    "id": "integer",
    "description": "string",
    "created_at": "string",
    "created_by_id": "integer",
    "host": "string",
    "original_url": "string",
    "is_link": "boolean",
    "type": "string",
    "version": "string",
    "title": "string",
    "author_name": "string",
    "author_url": "string",
    "provider_name": "string",
    "provider_url": "string",
    "cache_age": "integer",
    "thumbnail_url": "string",
    "thumbnail_width": "integer",
    "thumbnail_height": "integer",
    "url": "string",
    "width": "integer",
    "height": "integer",
    "html": "string"
  },
  "meeting_id": "integer",
  "meeting": {
    "id": "integer",
    "provider": "string",
    "provider_id": "string",
    "uuid": "string",
    "join_url": "string",
    "ended_at": "string",
    "recording_url": "string"
  },
  "option_count": "integer",
  "options": [
    {
      "id": "integer",
      "text": "string",
      "vote_count": "integer",
      "has_voted": "boolean",
      "voters": [
        "object"
      ]
    }
  ],
  "reactions": [
    {
      "id": "integer",
      "content": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "count": "integer"
    }
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "created_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "modified_at": "string",
  "modified_by_id": "integer",
  "modified_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "is_trashed": "boolean"
}

List messages

List messages.

GET /api/messages

Query parameters

q string: A query used to find matching items.

tag string: List items with the specified tag.

trashed boolean: Indicates whether trashed items should be listed (default is false). Specify null to return both trashed and non-trashed items.

order_by string: Specifies the sort order and direction for the listing, e.g. "name" or "name+desc"

top integer: Maximum number of items to return in the listing. Should be a value between 1 and 100. Default is 25.

skip integer: The number of items to skip. Used together with top to return a specific range of items (for pagination).

count_only boolean: true to only return the number of matching items; when this is specified the response will only contain the count property.

Example request

curl https://{WEAVY-SERVER}/api/messages
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Response codes

200 Success
401 Unauthorized

Response schema

{
  "data": [
    {
      "id": "integer",
      "app_id": "integer",
      "text": "string",
      "html": "string",
      "plain": "string",
      "attachment_count": "integer",
      "attachments": [
        "object"
      ],
      "embed_id": "integer",
      "meeting_id": "integer",
      "option_count": "integer",
      "options": [
        "object"
      ],
      "reactions": [
        "object"
      ],
      "metadata": "object",
      "tags": [
        "string"
      ],
      "created_at": "string",
      "created_by_id": "integer",
      "modified_at": "string",
      "modified_by_id": "integer",
      "is_trashed": "boolean"
    }
  ],
  "start": "integer",
  "end": "integer",
  "count": "integer"
}

List app messages

List messages in the specified app (chat or conversation).

GET /api/apps/{app}/messages

Path parameters

app string required: App identifier (id or uid)

Query parameters

q string: A query used to find matching items.

tag string: List items with the specified tag.

trashed boolean: Indicates whether trashed items should be listed (default is false). Specify null to return both trashed and non-trashed items.

order_by string: Specifies the sort order and direction for the listing, e.g. "name" or "name+desc"

top integer: Maximum number of items to return in the listing. Should be a value between 1 and 100. Default is 25.

skip integer: The number of items to skip. Used together with top to return a specific range of items (for pagination).

count_only boolean: true to only return the number of matching items; when this is specified the response will only contain the count property.

Example request

curl https://{WEAVY-SERVER}/api/apps/acme-chat/messages?top=50
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Response codes

200 Success
401 Unauthorized
404 Not Found

Response schema

{
  "data": [
    {
      "id": "integer",
      "app_id": "integer",
      "text": "string",
      "html": "string",
      "plain": "string",
      "attachment_count": "integer",
      "attachments": [
        "object"
      ],
      "embed_id": "integer",
      "meeting_id": "integer",
      "option_count": "integer",
      "options": [
        "object"
      ],
      "reactions": [
        "object"
      ],
      "metadata": "object",
      "tags": [
        "string"
      ],
      "created_at": "string",
      "created_by_id": "integer",
      "modified_at": "string",
      "modified_by_id": "integer",
      "is_trashed": "boolean"
    }
  ],
  "start": "integer",
  "end": "integer",
  "count": "integer"
}

Trash message

Move a message to the trash.

POST /api/messages/{id}/trash

Path parameters

id integer required: Id of the message to trash.

Example request

curl -X POST https://{WEAVY_SERVER}/api/messages/1/trash
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Response codes

200 Success
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found

Response schema

{
  "id": "integer",
  "app_id": "integer",
  "parent": {
    "id": "integer",
    "type": "string"
  },
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    {
      "id": "integer",
      "app_id": "integer",
      "version": "integer",
      "name": "string",
      "kind": "string",
      "media_type": "string",
      "width": "integer",
      "height": "integer",
      "size": "integer",
      "metadata": "object",
      "tags": [
        "string"
      ],
      "provider": "string",
      "raw": "string",
      "download_url": "string",
      "application_url": "string",
      "embed_url": "string",
      "external_url": "string",
      "preview_format": "string",
      "preview_url": "string",
      "thumbnail_url": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "modified_at": "string",
      "modified_by_id": "integer",
      "comment_count": "integer",
      "comments": [
        "object"
      ],
      "is_subscribed": "boolean",
      "is_trashed": "boolean"
    }
  ],
  "embed_id": "integer",
  "embed": {
    "id": "integer",
    "description": "string",
    "created_at": "string",
    "created_by_id": "integer",
    "host": "string",
    "original_url": "string",
    "is_link": "boolean",
    "type": "string",
    "version": "string",
    "title": "string",
    "author_name": "string",
    "author_url": "string",
    "provider_name": "string",
    "provider_url": "string",
    "cache_age": "integer",
    "thumbnail_url": "string",
    "thumbnail_width": "integer",
    "thumbnail_height": "integer",
    "url": "string",
    "width": "integer",
    "height": "integer",
    "html": "string"
  },
  "meeting_id": "integer",
  "meeting": {
    "id": "integer",
    "provider": "string",
    "provider_id": "string",
    "uuid": "string",
    "join_url": "string",
    "ended_at": "string",
    "recording_url": "string"
  },
  "option_count": "integer",
  "options": [
    {
      "id": "integer",
      "text": "string",
      "vote_count": "integer",
      "has_voted": "boolean",
      "voters": [
        "object"
      ]
    }
  ],
  "reactions": [
    {
      "id": "integer",
      "content": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "count": "integer"
    }
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "created_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "modified_at": "string",
  "modified_by_id": "integer",
  "modified_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "is_trashed": "boolean"
}

Restore message

Restore a message from the trash.

POST /api/messages/{id}/restore

Path parameters

id integer required: Id of the message to restore.

Example request

curl -X POST https://{WEAVY_SERVER}/api/messages/1/restore
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Response codes

200 Success
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found

Response schema

{
  "id": "integer",
  "app_id": "integer",
  "parent": {
    "id": "integer",
    "type": "string"
  },
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    {
      "id": "integer",
      "app_id": "integer",
      "version": "integer",
      "name": "string",
      "kind": "string",
      "media_type": "string",
      "width": "integer",
      "height": "integer",
      "size": "integer",
      "metadata": "object",
      "tags": [
        "string"
      ],
      "provider": "string",
      "raw": "string",
      "download_url": "string",
      "application_url": "string",
      "embed_url": "string",
      "external_url": "string",
      "preview_format": "string",
      "preview_url": "string",
      "thumbnail_url": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "modified_at": "string",
      "modified_by_id": "integer",
      "comment_count": "integer",
      "comments": [
        "object"
      ],
      "is_subscribed": "boolean",
      "is_trashed": "boolean"
    }
  ],
  "embed_id": "integer",
  "embed": {
    "id": "integer",
    "description": "string",
    "created_at": "string",
    "created_by_id": "integer",
    "host": "string",
    "original_url": "string",
    "is_link": "boolean",
    "type": "string",
    "version": "string",
    "title": "string",
    "author_name": "string",
    "author_url": "string",
    "provider_name": "string",
    "provider_url": "string",
    "cache_age": "integer",
    "thumbnail_url": "string",
    "thumbnail_width": "integer",
    "thumbnail_height": "integer",
    "url": "string",
    "width": "integer",
    "height": "integer",
    "html": "string"
  },
  "meeting_id": "integer",
  "meeting": {
    "id": "integer",
    "provider": "string",
    "provider_id": "string",
    "uuid": "string",
    "join_url": "string",
    "ended_at": "string",
    "recording_url": "string"
  },
  "option_count": "integer",
  "options": [
    {
      "id": "integer",
      "text": "string",
      "vote_count": "integer",
      "has_voted": "boolean",
      "voters": [
        "object"
      ]
    }
  ],
  "reactions": [
    {
      "id": "integer",
      "content": "string",
      "created_at": "string",
      "created_by_id": "integer",
      "count": "integer"
    }
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "created_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "modified_at": "string",
  "modified_by_id": "integer",
  "modified_by": {
    "id": "integer",
    "uid": "string",
    "display_name": "string",
    "email": "string",
    "given_name": "string",
    "middle_name": "string",
    "name": "string",
    "family_name": "string",
    "nickname": "string",
    "phone_number": "string",
    "comment": "string",
    "directory_id": "integer",
    "picture_id": "integer",
    "avatar_url": "string",
    "metadata": "object",
    "tags": [
      "string"
    ],
    "presence": "string",
    "created_at": "string",
    "modified_at": "string",
    "is_bot": "boolean",
    "is_suspended": "boolean",
    "is_trashed": "boolean"
  },
  "is_trashed": "boolean"
}

Delete message

Permanently delete a message.

DELETE /api/messages/{id}

Path parameters

id integer required: Id of the message.

Example request

curl -X DELETE https://{WEAVY_SERVER}/api/messages/1
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Response codes

204 No Content
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found