CardPlatform Adaptive Cards (Preview)

Reference

CardPlatform allows you to send Adaptive Cards to users. Can be used for actional content, such as approvals, forms capture, and general messaging. It supports templating and custom cards.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	CardPlatform Support
URL	https://cardplatform.app/support
Email	support@cardplatform.app

Connector Metadata
Publisher	CardPlatform
Website	https://cardplatform.app/
Privacy policy	https://cardplatform.app/privacy/
Categories	Collaboration;Communication

CardPlatform allows you to send Adaptive Cards and actionable content directly to your users.

Pre-requisites

To use CardPlatform, you will need to:

Create a CardPlatform subscription, to start select the plan;
There is a free trial subscriptions which is available to trial and experiment with.

How to get credentials

After signup has completed, you will receive your API Key in an email.

Once you have the API Key, create a new Connection, enter the API Key, and start sending cards.

Getting started with your connector

To get started, first send a message:

Choose the Send Message action

Fill in the three fields

Select the Send Message action

Recipients - fill in your email address;
Heading - Write a heading, e.g. Hello World

Insert the adaptive card, this example will send Hello World in the card, e.g.

{
    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
    "type": "AdaptiveCard",
    "version": "1.0",
    "body": [
        {
            "type": "TextBlock",
            "size": "Large",
            "isSubtle": true,
            "wrap": true,
            "text": "Hello World"
        }
    ]
}

Run the flow, and the card will appear in Outlook

Known issues and limitations

If your adaptive cards are not being shown in Outlook, there is an Outlook plugin called Actionnable Message Debugger that can assist in resolving the issue.

Install from Actionable Message Debugger site.

Extra support is available on the CardPlatform Support site.

FAQ

How do I send an approval?

Use the Send Approval action;
How do I send a message, without waiting for a reply?

Use the Send Message action;
How do I design my Adaptive Cards?

Use the Adaptive Card Designer to create your Adaptive Cards;
Where do I find the schema and samples for Adaptive Cards?

The schema and samples can be found on:
- adaptivecards.io
- madewithcards.io
What are templates?

A template allows you to design the Adaptive Card, and then apply the data to it, seperating data from the layout of the Adaptive Card.
1. What are public templates?
  
  Public templates are created by the community and available for all to use. All the public templates can be listed by using the List public templates action;
2. What are private templates?
  
  Private templates are you own private collection of templates, that can be stored and reused.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	API Key from CardPlatform	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a private template	Create a new private template.
Delete private template	Removes a private template from the set of private templates.
Find a public template	Find a public template by analyzing the structure of your data.
Get a private template	Retrieves a private template by name.
Get a public template	Retrieves the contents of a public template.
List private templates	Retrieves a list of all private templates.
List public templates	Retrieves a list of all public templates.
Send Adaptive Card	Sends an Adaptive Card, and returns the response with the choice and fields entered.
Send Approval	Sends an Approval Adaptive Card, and returns the response with the choice and fields entered.
Send Message	Sends an Adaptive Card as a message (no actions).
Transform private template	Populates a private template with the data and returnes a fully populated Adaptive Card.
Transform public template	Populates a public template with the data and returnes a fully populated Adaptive Card.
Update a private template	Updates the contents of a private template.

Create a private template

Operation ID:: PrivateTemplates_Create

Create a new private template.

Parameters

Name	Key	Required	Type	Description
Template Name	name	True	string	Template Name
			object

Returns

response: object

Delete private template

Operation ID:: PrivateTemplates_Delete

Removes a private template from the set of private templates.

Parameters

Name	Key	Required	Type	Description
Template Name	name	True	string	Template Name

Find a public template

Operation ID:: PublicTemplate_Find

Find a public template by analyzing the structure of your data.

Parameters

Name	Key	Required	Type	Description
			object

Returns

response: object

Get a private template

Operation ID:: PrivateTemplate_Get

Retrieves a private template by name.

Parameters

Name	Key	Required	Type	Description
Name of private template	name	True	string	Name of private template

Returns

response: object

Get a public template

Operation ID:: PublicTemplate_Get

Retrieves the contents of a public template.

Parameters

Name	Key	Required	Type	Description
Path of public template	path	True	string	Path of public template

Returns

Templates List

Templates List: TemplateListSchema

List private templates

Operation ID:: PrivateTemplate_GetAll

Retrieves a list of all private templates.

Returns

Name	Path	Type	Description
		array of string

List public templates

Operation ID:: PublicTemplate_GetAll

Retrieves a list of all public templates.

Returns

response: object

Send Adaptive Card

Operation ID:: SendCard

Sends an Adaptive Card, and returns the response with the choice and fields entered.

Parameters

Name	Key	Required	Type	Description
Recipients	recipients	True	array of string	Recipients email address
Heading	heading	True	string	Heading
Adaptive Card	card	True	string	Adaptive Card
ID	id		string	ID to identify the card
Name of Card	cardname		string	Name of Card

Returns

Response from previous card

Response: ResponseSchema

Send Approval

Operation ID:: SendApproval

Sends an Approval Adaptive Card, and returns the response with the choice and fields entered.

Parameters

Name	Key	Required	Type	Description
Recipients	recipients	True	array of string	Recipients email
Heading	heading	True	string	Heading
Instructions	instructions	True	string	Instructions
Actions	actions	True	array of string	List of Actions
Type of choice	choiceType	True	string	Type of choice
Default Choice for approve	approvalChoice	True	string	Default Choice for approve
Default Choice for reject	rejectionChoice	True	string	Default Choice for reject

Returns

Response from previous card

Response: ResponseSchema

Send Message

Operation ID:: SendMessage

Sends an Adaptive Card as a message (no actions).

Parameters

Name	Key	Required	Type	Description
Recipients	recipients	True	array of string	Recipients email address
Heading	heading	True	string	Heading
Adaptive Card	card	True	string	Adaptive Card

Returns

response: CardResponseSchema

Transform private template

Operation ID:: PrivateTemplate_Transform

Populates a private template with the data and returnes a fully populated Adaptive Card.

Parameters

Name	Key	Required	Type	Description
Template Name	name	True	string	Template Name
			object

Returns

response: object

Transform public template

Operation ID:: PublicTemplate_Transform

Populates a public template with the data and returnes a fully populated Adaptive Card.

Parameters

Name	Key	Required	Type	Description
Public Template Path	path	True	string	Path of public template
			object

Returns

response: object

Update a private template

Operation ID:: PrivateTemplates_Update

Updates the contents of a private template.

Parameters

Name	Key	Required	Type	Description
Template Name	name	True	string	Template Name
			object

Definitions

ResponseSchema

Response from previous card

Name	Path	Type
respondent	respondent	string
respondentName	respondentName	string
respondentEmail	respondentEmail	string
choice	choice	string
comment	comment	string
responseDate	responseDate	string

TemplateListSchema

Templates List

Name	Path	Type
list	list	array of object
key	list.key	string
templates	list.templates	array of object
file	list.templates.file	string
fullPath	list.templates.fullPath	string

CardResponseSchema

: string

object

This is the type 'object'.

Aracılığıyla paylaş

CardPlatform Adaptive Cards (Preview)

Pre-requisites

How to get credentials

Getting started with your connector

Known issues and limitations

FAQ

Creating a connection

Default

Throttling Limits

Actions

Create a private template

Parameters

Returns

Delete private template

Parameters

Find a public template

Parameters

Returns

Get a private template

Parameters

Returns

Get a public template

Parameters

Returns

List private templates

Returns

List public templates

Returns

Send Adaptive Card

Parameters

Returns

Send Approval

Parameters

Returns

Send Message

Parameters

Returns

Transform private template

Parameters

Returns

Transform public template

Parameters

Returns

Update a private template

Parameters

Definitions

ResponseSchema

TemplateListSchema

CardResponseSchema

object

Ek kaynaklar