Action Link Definition Input

The definition of an action link. An action link is an indicator on a feed element that targets an API, a Web page, or a file and is represented by a button in the Salesforce Chatter feed UI. An action link includes an HTTP method and can include header information, such as a bearer token for authentication. Use action links to integrate Salesforce and third-party systems into the feed.

Action Links are currently available to select customers through a pilot program. To be nominated to join this pilot program, contact salesforce.com. Additional terms and conditions may apply to participate in the pilot program. Please note that pilot programs are subject to change, and as such, we cannot guarantee acceptance into this pilot program or a particular time frame in which this feature can be enabled. Any unreleased services or features referenced in this document, press releases, or public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make their purchase decisions based upon features that are currently available.

Note

Root XML tag

<actionLinkDefinition>

JSON example

1{
2   "actionType":"Api",
3   "actionUrl":"/services/data/v32.0/chatter/feed-elements",
4   "groupDefault":"true",
5   "labelKey":"Post",
6   "method":"Post",
7   "requiresConfirmation":"true",
8   "requestBody":"{\"subjectId\": \"me\",\"feedElementType\": \"FeedItem\",\"body\": {\"messageSegments\": [{\"type\": \"Text\",\"text\": \"Testing a post created via an API action link.\"}]}}",
9   "headers":[
10   {
11      "name":"Content-Type", "value":"application/json"
12   }]
13}

Properties

Name	Type	Description	Required or Optional	Available Version
`actionType`	String	Defines the type of action link. Values are: `Api`—The action link calls a synchronous API. `ApiAsync`—The action link calls an asynchronous API. `Download`—The action link downloads a file. `Ui`—The action link takes the user to a user interface. Use `Ui` if you need to load a page before the user performs an action, for example, to have the user provide input or view something before the action happens.	Required	31.0
`actionUrl`	String	The action link URL. For example, for a `Ui` action link, the URL may be a Web page. For a `Download` action link, the URL is a link to the file to download. `Ui` and `Download` action link URLs are provided to clients. For an `Api` or `ApiAsync` action link, the URL may be a REST resource. `Api` and `ApiAsync` action link URLs aren’t provided to clients. Links to Salesforce can be relative. All other links must be absolute and start with `https://`. To avoid issues due to upgrades or changing functionality in your API, we recommend using a versioned API for `actionUrl`, for example, https://www.example.com/api/v1/exampleResource. If your API isn’t versioned, you can use the `expirationDate` property of the Action Link Group Definition Input to avoid issues due to upgrades or changing functionality in your API. Tip	Required	31.0
`excludedUserId`	String	ID of a single user to exclude from performing the action. If you specify an `excludedUserId`, you can’t specify a `userId`.	Optional	31.0
`groupDefault`	Boolean	`true` if this action is the default or primary action link in the action link group; `false` otherwise. There can be only one default action link per action link group.	Required	31.0
`headers`	Request Header Input[]	The request headers for the `Api` and `ApiAsync` action link types.	Optional	31.0
`labelKey`	String	Key for the set of labels to show in the user interface. A set includes labels for these states: new, pending, success, failed. For example, if you use the `Approve` key, you get these labels: Approve, Pending, Approved, Failed. For a complete list of keys and labels, see Action Links Labels.	Required	31.0
`method`	String	One of these HTTP methods: `Delete`—Returns HTTP 204 on success. Response body is empty. `Get`—Returns HTTP 200 on success. `Head`—Returns HTTP 200 on success. Response body is empty. `Patch`—Returns HTTP 200 on success or HTTP 204 if the response body is empty. `Post`—Returns HTTP 201 on success or HTTP 204 if the response body is empty. Exceptions are the batch posting resources, which return HTTP 200 on success. `Put`—Return HTTP 200 on success or HTTP 204 if the response body is empty.	Required	31.0
`requestBody`	String	The request body for `Api` and `ApiAsync` action link types. You must escape quotation mark characters in the `requestBody` value. Note	Optional	31.0
`requiresConfirmation`	Boolean	`true` if the action results in something that should be confirmed, such as a delete; `false` otherwise.	Required	31.0
`userId`	String	The ID of the user who can execute the action. If not specified or `null`, any user can execute the action. If you specify a `userId`, you can’t specify an `excludedUserId`.	Optional	31.0

Chatter REST API Developer's Guide

No Results

Action Link Definition Input