Skip to main content
Mural logo
  • Category: team collaboration
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 40
  • Triggers: 0
  • Slug: MURAL
  • Version: 20261101_00

Tools

Slug: MURAL_AUTHORIZATION_REQUESTTool to initiate the OAuth 2.0 authorization process. Use when you need to redirect a user to Mural to obtain an authorization code.

Input Parameters

array
required
List of permission scopes to request. Provided as a list of strings; they will be joined with spaces in the URL.
string
Optional opaque value sent and returned in the callback to prevent CSRF and correlate requests.
string
required
The client identifier for your Mural app (provided when registering your app).
string
required
The callback URL where users are redirected after granting access. Must match one of your app’s registered redirect URLs.
string
Grant type for authorization code flow; must be ‘code’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_AREACreate an area widget that can organize content on a mural.

Input Parameters

number
Horizontal position of the area in pixels.
number
Vertical position of the area in pixels.
object
Optional styling for a new area widget.
string
Area title shown on the mural and in the outline.
number
Area width in pixels.
number
Area height in pixels.
boolean
Whether the area is hidden from non-facilitators in the outline.
string ("free" | "column" | "row")
Layout used to arrange widgets in the area.
string
required
Unique identifier of the mural.
string
Identifier of the parent area widget.
boolean
Whether the area title is displayed.
string
Facilitator instructions for the area in the outline.
number
Z-index stacking order of the area.
number
List order of the area in the outline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_ARROWCreate one arrow widget on a mural.

Input Parameters

number
required
Horizontal position of the arrow in pixels.
number
required
Vertical position of the arrow in pixels.
string ("no tip" | "single" | "double")
Arrow tip type. Defaults to single.
object
Arrow label and its formatting.
object
Connector stroke styling.
string
Arrow title in the mural outline.
number
required
Width of the arrow in pixels.
number
required
Height of the arrow in pixels.
array
required
At least two points defining the connector path.
string
required
Unique identifier of the mural.
string
Widget ID connected to the arrow’s end point.
string
ID of the containing area widget.
number
Clockwise rotation in degrees from 0 up to, but not including, 360.
string ("straight" | "curved" | "orthogonal")
Arrow line type. Defaults to straight.
boolean
Whether the arrow can be stacked. Defaults to true.
string
Widget ID connected to the arrow’s start point.
string
Facilitator instructions for the outline section.
number
Z-index stacking order of the arrow.
number
Position in the mural outline. Defaults to -1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_ASSETCreate a signed upload target for an image or file attached to a mural.

Input Parameters

string
required
Unique identifier of the mural.
string ("image" | "file")
Type of asset that will be uploaded. Defaults to file.
string
required
File extension for the asset, without a leading period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_IMAGECreate an image widget from an uploaded Mural asset name.

Input Parameters

number
required
Horizontal position in pixels.
number
required
Vertical position in pixels.
string
required
Asset name returned after creating and uploading a Mural image asset.
number
required
Width of the image widget in pixels.
boolean
Whether a black border is displayed around the image.
number
required
Height of the image widget in pixels.
boolean
Whether the widget is hidden from non-facilitators in the outline.
string
Caption and outline title.
string
required
Unique identifier of the mural.
string
ID of the containing area widget.
number
Rotation in degrees from 0 up to, but not including, 360.
URL opened from the image widget.
string
Image caption description.
string
Facilitator instructions for the outline section.
boolean
Whether the caption and description are displayed.
number
Z-index stacking order of the image widget.
number
Position of the image widget in the mural outline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_MURALCreate a new blank mural in a room owned by the connected user.

Input Parameters

string
Title of the mural.
number
Canvas width in pixels.
number
Canvas height in pixels.
integer
required
Unique identifier of the room.
string
UUID of the folder that will contain the mural.
boolean
Whether the canvas is borderless and grows with its content.
string
Canvas color in #RRGGBBAA format.
string ("airplane" | "cello" | "cuckoo")
Timer sound theme for the mural.
object
Visitor-link settings for a new mural.
string ("animals" | "music" | "travel")
Visitor avatar theme for the mural.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_MURAL_FROM_TEMPLATECreate a new mural in a room using an existing template.

Input Parameters

string
required
Title for the new mural.
integer
required
Unique identifier of the destination room.
string
Unique identifier of the destination folder.
string
required
Unique identifier of the template to instantiate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_SHAPESCreate between one and 1000 shape widgets on a mural in one request.

Input Parameters

array
required
Shapes to create as a direct array. Supply between 1 and 1000 items.
string
required
Unique identifier of the mural.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_STICKY_NOTECreate up to 1000 sticky note widgets on a mural in one request.

Input Parameters

string
required
Unique identifier of the mural
array
required
Array of sticky note objects to create. Each object must have ‘x’ and ‘y’ coordinates. Pass objects directly, not strings or nested structures. Maximum 1000 items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_TEXTBOXCreate up to 1000 text box widgets on a mural.

Input Parameters

string
required
Unique identifier of the mural.
array
required
Text boxes to create as a direct array. Maximum 1000 items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_CREATE_TITLE_WIDGETSCreate up to 1000 title widgets on a mural.

Input Parameters

array
required
Title widget definitions sent as a direct array. Maximum 1000 items.
string
required
Unique identifier of the destination mural.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_DELETE_WIDGETPermanently delete a widget and its content from a mural.

Input Parameters

string
required
Unique identifier of the mural.
string
required
Unique identifier of the widget to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_EXPORT_MURALQueue a mural export to a PDF file and return its export process ID.

Input Parameters

string
required
Unique identifier of the mural to export.
string
required
File extension for the export. MURAL currently supports ‘pdf’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_GET_CURRENT_USERTool to retrieve information about the currently authenticated user. Use when you need current user details after authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_GET_FILES_FOR_MURALTool to retrieve a list of file widgets in a mural. Use after confirming the mural ID when listing file attachments.

Input Parameters

string
Pagination token for next page of items
integer
Maximum number of results to return
string
required
Unique identifier of the mural

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_GET_MURALRetrieve metadata for a mural by its unique identifier.

Input Parameters

string
required
Unique identifier of the mural.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_GET_MURAL_WIDGETSRetrieve widgets within a specified mural, including sticky notes, text boxes, shapes, images, areas, arrows, icons, files, and comments; drawings are not currently included. Supports filtering by widget type and parent container, and pagination.

Input Parameters

string
Pagination token from previous response to retrieve the next page of results.
array
List of widget types to filter by (e.g., [‘area’, ‘sticky note’]). When omitted, returns all widget types.
integer
Maximum number of widgets to return per page (must be ≥1). Use with ‘next’ for pagination.
string
required
Unique identifier of the mural.
string
Filter to return only widgets contained within the specified parent widget ID (typically an area widget).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_GET_ROOMTool to retrieve information about a specific room by its ID. Use when you need details about a particular room that the authenticated user has read access to.

Input Parameters

string
required
Unique identifier of the room to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_GET_WIDGETGet one widget by its mural and widget identifiers.

Input Parameters

string
required
Unique identifier of the mural.
string
required
Unique identifier of the widget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_GET_WORKSPACETool to retrieve information about a specific workspace by its ID. Use when you need details about a particular workspace that the authenticated user has read access to.

Input Parameters

string
required
Unique identifier of the workspace to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_GET_WORKSPACESTool to retrieve all workspaces the authenticated user is a member of. Use to list available workspaces before accessing rooms or murals.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of workspaces to return per page (must be ≥1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_FOLDERSTool to list all folders within a room that the authenticated user has access to. Use after MURAL_LIST_ROOMS to navigate folders within a specific room.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of folders to return per page (must be ≥1)
string
required
Unique identifier of the room to list folders from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_OPEN_ROOMSTool to list all discoverable open rooms within a workspace. Use when you need to access publicly available rooms in a workspace that don’t require specific membership.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of rooms to return per page (must be ≥1)
string
required
Unique identifier of the workspace to list open rooms from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_RECENT_MURALSTool to list recently opened active murals for the authenticated user in a workspace. Use after MURAL_LIST_WORKSPACES to view recent murals before opening or editing them.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of murals to return per page (must be ≥1)
string
required
Unique identifier of the workspace to list recent murals from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_RECENT_TEMPLATESTool to retrieve recent templates used by a user for a workspace. Use when you need to access recently used templates for creating new murals.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of templates to return per page (must be ≥1)
string
required
Unique identifier of the workspace to list recent templates from
boolean
If true, the list of returned templates will not include default templates

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_ROOM_MURALSTool to list all murals for a room that the authenticated user has read access to. Use after getting a room ID to retrieve murals within that room.

Input Parameters

string
Token to get the next page of items
integer
Maximum number of results to be returned by the endpoint
integer
required
Unique identifier of the room to list murals from
string ("lastCreated" | "lastModified" | "oldest")
Sort order options for murals.
string ("active" | "archived")
Status filter for murals.
string
When set, filter murals by their corresponding folder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_ROOMSList rooms in a workspace that the authenticated user can read. The user must have access to both the workspace and the rooms.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of rooms to return per page (must be ≥1)
string
required
Unique identifier of the workspace to list rooms from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_ROOM_USERSTool to list all members and guests for a room. Returns users that the authenticated user has access to view. Use after LIST_ROOMS to get room membership details.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of users to return per page (must be ≥1)
string
required
Unique identifier of the room to list users from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_TAGSTool to retrieve all tags in a mural. Use when you need to list or view tags associated with a specific mural.

Input Parameters

string
required
Unique identifier of a mural

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_TEMPLATESTool to retrieve all default templates available in Mural. Use when you need to browse or select from standard Mural templates.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of templates to return per page (must be ≥1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_WORKSPACE_MURALSTool to list all murals in a workspace that the authenticated user owns or is a member of. Use after getting a workspace ID to browse available murals.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of murals to return per page (must be ≥1)
string ("lastCreated" | "lastModified" | "oldest")
Sort order for murals.
string ("active" | "archived")
Status filter for murals.
string
required
Unique identifier of the workspace to list murals from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_LIST_WORKSPACE_TEMPLATESTool to get default and custom templates for a workspace. Use when you need to list available templates after authentication.

Input Parameters

string
Pagination token for retrieving the next page of results
integer
Maximum number of templates to return per page (must be ≥1)
string
required
Unique identifier of the workspace to list templates from
boolean
If true, the list of returned templates will not include default templates

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_SEARCH_MURALSTool to search for murals within a workspace. Returns all murals that the authenticated user owns or is a member of for the specified workspace. Use when searching for specific murals by query text.

Input Parameters

string
required
The text this search query is for
string
Token to get the next page of items
integer
Maximum number of results to be returned by the endpoint (must be ≥1)
integer
Unique identifier of a room. When provided, restrict the results to murals in the specified room.
string
required
Unique identifier of the workspace to search murals in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_SEARCH_ROOMSTool to search for rooms within a workspace by name or description. Returns all rooms that the authenticated user owns or is a member of matching the query. Use when you need to find specific rooms by search text.

Input Parameters

string
required
The search query text to filter rooms by name or description
string
Pagination token for retrieving the next page of results
integer
Maximum number of rooms to return per page (must be ≥1)
string
required
Unique identifier of the workspace to search rooms from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_SEARCH_TEMPLATESSearch custom templates within a workspace that the authenticated user owns or has access to, using a name or keyword query.

Input Parameters

string
required
The text search query for finding templates
string
Pagination token for retrieving the next page of results
integer
Maximum number of templates to return per page (must be ≥1)
string
required
Unique identifier of the workspace to search templates in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_UPDATE_AREAUpdate documented properties of an existing area widget on a mural.

Input Parameters

number
Horizontal position in pixels.
number
Vertical position in pixels.
object
Style properties that can be changed on an area widget.
string
Title shown for the area.
number
Width of the area in pixels.
number
Height of the area in pixels.
boolean
Whether the area is hidden from non-facilitators in the outline.
string ("free" | "column" | "row")
Layout applied to widgets inside the area.
string
required
Unique identifier of the mural.
string
Identifier of the parent area widget.
string
required
Unique identifier of the area widget.
boolean
Whether the area title is displayed.
string
Facilitator-managed instructions for the outline section.
number
Position of the area in the outline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_UPDATE_ARROWUpdate documented properties of an existing arrow widget on a mural.

Input Parameters

number
Horizontal position in pixels.
number
Vertical position in pixels.
string ("no tip" | "single" | "double")
Arrow tip type.
object
Arrow label and its formatting.
object
Connector stroke styling.
string
Arrow title in the mural outline.
number
Width of the arrow in pixels.
number
Height of the arrow in pixels.
array
At least two points defining the connector path.
string
required
Unique identifier of the mural.
string
Widget ID connected to the arrow’s end point.
string
ID of the containing area widget.
number
Clockwise rotation in degrees from 0 up to, but not including, 360.
string
required
Unique identifier of the arrow widget.
string ("straight" | "curved" | "orthogonal")
Arrow line type.
boolean
Whether the arrow can be stacked.
string
Widget ID connected to the arrow’s start point.
string
Facilitator instructions for the outline section.
number
Position of the arrow in the mural outline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_UPDATE_SHAPEUpdate documented properties of an existing shape widget on a mural.

Input Parameters

number
Horizontal position in pixels.
number
Vertical position in pixels.
string
Plain text shown in the shape.
object
Style properties that can be changed on a shape widget.
string
Title shown in the outline.
number
Width of the shape in pixels.
number
Height of the shape in pixels.
boolean
Whether the shape is hidden from non-facilitators in the outline.
string
required
Unique identifier of the mural.
string
Shape text with supported inline HTML formatting.
string
Identifier of the parent area widget.
number
Rotation angle in degrees from 0 up to, but not including, 360.
string
required
Unique identifier of the shape widget.
string
Facilitator-managed instructions for the outline section.
number
Position of the shape in the outline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_UPDATE_STICKY_NOTEUpdate documented properties of an existing sticky-note widget on a mural.

Input Parameters

number
Horizontal position in pixels.
number
Vertical position in pixels.
array
Unique identifiers of tags assigned to the widget.
string
Plain text displayed in the widget.
object
Style properties that can be changed on a sticky-note widget.
string
Widget title in the mural outline.
number
Width of the widget in pixels.
number
Height of the widget in pixels.
boolean
Whether the widget is hidden from non-facilitators in the outline.
string
required
Unique identifier of the mural.
string
Text with supported inline HTML formatting.
string
ID of the containing area widget.
number
Rotation in degrees from 0 up to, but not including, 360.
string
required
Unique identifier of the sticky-note widget.
URL used in the widget.
string
Facilitator instructions for the outline section.
Text displayed on the hyperlink button.
number
Position of the widget in the mural outline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MURAL_UPDATE_TEXTBOXPartially update a textbox widget’s content, style, size, or position.

Input Parameters

number
Horizontal position in pixels.
number
Vertical position in pixels.
string
Text displayed in the widget.
object
Textbox style properties accepted by MURAL’s update endpoint.
string
Widget title in the outline.
number
Width of the widget in pixels.
number
Height of the widget in pixels.
boolean
Whether the widget is hidden from non-facilitators when it is in the outline.
string
required
Unique identifier of the mural.
string
ID of the area widget that contains this widget.
number
Widget rotation in degrees, from 0 inclusive to 360 exclusive.
string
required
Unique identifier of the textbox widget.
URL used in the widget, up to 1024 characters.
string
Facilitator instructions for the widget in the outline.
Text displayed on the hyperlink button.
number
List order of the widget in the outline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not