Schema Explorer

Action.OpenUrl

When invoked, show the given url either by launching it in an external web browser or showing in-situ with embedded web browser.

Property Type Required Description Version
type string Yes Must be "Action.OpenUrl". 1.0
title string No Label for button or link that represents this action. 1.0
iconUrl string No Optional icon to be shown on the action in conjunction with the title 1.1
url string Yes The URL to open. 1.0

Example

{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.0",
	"body": [
		{
			"type": "TextBlock",
			"text": "This card's action will open a URL"
		}
	],
	"actions": [
		{
			"type": "Action.OpenUrl",
			"title": "Action.OpenUrl",
			"url": "http://adaptivecards.io"
		}
	]
}
{ "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.0", "body": [ { "type": "TextBlock", "text": "This card's action will open a URL" } ], "actions": [ { "type": "Action.OpenUrl", "title": "Action.OpenUrl", "url": "http://adaptivecards.io" } ] }
Try it Yourself »

Properties

type

Must be "Action.OpenUrl".

  • Type: string
  • Required: Yes

title

Label for button or link that represents this action.

  • Type: string
  • Required: No

iconUrl

Optional icon to be shown on the action in conjunction with the title

  • Type: string
  • Required: No
  • Format: uri

Example

{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.1",
	"body": [
		{
			"type": "TextBlock",
			"text": "This card has an action with an icon. Icon placement and size depend on host.",
			"wrap": true
		}
	],
	"actions": [
		{
			"type": "Action.OpenUrl",
			"iconUrl": "http://adaptivecards.io/content/cats/1.png",
			"url": "http://adaptivecards.io",
			"title": "With Icon"
		}
	]
}
{ "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.1", "body": [ { "type": "TextBlock", "text": "This card has an action with an icon. Icon placement and size depend on host.", "wrap": true } ], "actions": [ { "type": "Action.OpenUrl", "iconUrl": "http://adaptivecards.io/content/cats/1.png", "url": "http://adaptivecards.io", "title": "With Icon" } ] }
Try it Yourself »

url

The URL to open.

  • Type: string
  • Required: Yes
  • Format: uri