Internal
Optional
assigneeUnique user identifier. In the GUI, the user ID is mapped to the name of the user who is assigned as the owner of the task or activity described in the card. The identifier is numeric, and it is automatically assigned to a user when they first sign up.
The actual text (content) that appears in the sticky note item.
Optional
contentType of the embedded item's content.
Optional
descriptionA short text description to add context about the app card.
Optional
documentThe URL to download the resource. You must use your access token to access the URL. The URL contains the redirect
parameter to control the request execution. redirect
: By default, the redirect
parameter is set to false
and the resource object containing the URL and the resource type is returned with a 200 OK HTTP code. This URL is valid for 60 seconds. You can use this URL to retrieve the resource file. If the redirect
parameter is set to true
, a 307 TEMPORARY_REDIRECT HTTP response is returned. If you follow HTTP 3xx responses as redirects, you will automatically be redirected to the resource file and the content type returned is application/octet-stream
.
Optional
dueThe date when the task or activity described in the card is due to be completed. In the GUI, users can select the due date from a calendar. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
Optional
fieldsArray where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.
Optional
formatOnly custom frames are supported at the moment.
Optional
htmlHtml code of the embedded item.
Optional
imageThe URL to download the resource. You must use your access token to access the URL. The URL contains the redirect
parameter and the format
parameter to control the request execution as described in the following parameters: format
parameter: By default, the image format is set to the preview image. If you want to download the original image, set the format
parameter in the URL to original
. redirect
: By default, the redirect
parameter is set to false
and the resource object containing the URL and the resource type is returned with a 200 OK HTTP code. This URL is valid for 60 seconds. You can use this URL to retrieve the resource file. If the redirect
parameter is set to true
, a 307 TEMPORARY_REDIRECT HTTP response is returned. If you follow HTTP 3xx responses as redirects, you will automatically be redirected to the resource file and the content type returned can be image/png
, 'image/svg', or 'image/jpg', depending on the original image type.
Optional
modeDefines how the content in the embed item is displayed on the board. inline
: The embedded content is displayed directly on the board. modal
: The embedded content is displayed inside a modal overlay on the board.
Optional
ownedDefines whether the card is owned by the application making the call.
Optional
previewThe URL to download the resource. You must use your access token to access the URL. The URL contains the redirect
parameter and the format
parameter to control the request execution as described in the following parameters: format
parameter: By default, the image format is set to the preview image. If you want to download the original image, set the format
parameter in the URL to original
. redirect
: By default, the redirect
parameter is set to false
and the resource object containing the URL and the resource type is returned with a 200 OK HTTP code. This URL is valid for 60 seconds. You can use this URL to retrieve the resource file. If the redirect
parameter is set to true
, a 307 TEMPORARY_REDIRECT HTTP response is returned. If you follow HTTP 3xx responses as redirects, you will automatically be redirected to the resource file and the content type returned can be image/png
, 'image/svg', or 'image/jpg', depending on the original image type.
Optional
providerName of the content's provider.
Optional
providerUrl of the content's provider.
Optional
shapeDefines the geometric shape of the sticky note and aspect ratio for its dimensions.
Optional
statusStatus indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns disabled
.
Optional
titleTitle of the frame. This title appears at the top of the frame.
Optional
typeOnly free form frames are supported at the moment.
Optional
urlA valid URL pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS.
Contains the item data, such as the item title, content, or description.