With AppCloud Actions, developers can build apps that control an external action that occurs when contacts enter a step on the campaign canvas. Examples of this could include sending contacts SMS messages, a direct mail piece, or registering them for webinars. When contacts enter an action step, Eloqua will call out to the app, and the app can respond by performing an action in an external system, then informing Eloqua that the process is complete. The contact will then move on in the workflow.
Think of AppCloud Actions as the next generation of Eloqua's popular Cloud Connectors framework.
When you set up an AppCloud Action service, you will need to provide the usual AppCloud Developer framework service details, as well as the Instance Configuration and Action Settings.
Service Details
These fields are present for all service types:
- Icon URL: the URL of the icon that Eloqua will display for your service.
- Name: the name of your service.
- Description: a description of what your service does.
Instance Configuration
This section defines the URLs for creating, configuring, copying, and deleting an instance of your service. The installation tutorial details the instance creation flow when a marketer drags an AppCloud Action step onto the canvas, and selects your app.
Each URL is a templated URL that uses common URL template parameters and some Eloqua Markup Language parameters. These parameters are replaced by their appropriate values when the system makes a call. For more about URL templating, see: Using a Templated URL.
- Create URL: templated URL pointing to a web poral for creating an instance of this service as an HTTP POST request. All common URL template parameters are available. You should be sure to included, at a minimum, the {InstanceId} parameter so that you will be able to identify the service in the future. On success, this endpoint should return a 200-level response with the created instance.
- Configure URL: templated URL pointing to an endpoint for configuring an instance of this service as an HTTP GET request. All common URL template parameters are available.
- Delete URL: templated URL pointing to an endpoint for deleting an instance of this service using an HTTP DELETE request. All common URL template parameters are available. On success, this endpoint should return a 200-level response.
- Copy URL: templated URL pointing to an endpoint for creating an instance of this service as an HTTP POST request. All common URL template parameters are available in addition to {OriginalInstanceId}, {OriginalInstallId}, {OriginalAssetId}, and {OriginalAssetName}. You should be sure to include, at a minimum, the {InstanceId} and {OriginalInstanceId} parameters so that you can identify the original and newly-created instances. On success, this endpoint should return a 200-level response with the created instance.
Action Settings
- Notification versus Polling: Specify whether Eloqua should call out to your service when a member arrives in an Action Step, or whether you will poll for members periodically.
- Notification URL: This url will be called (HTTP POST) when actions are taken on an instance of this service. This endpoint should return a 2xx level response with an empty body on success. If this property is not specified, the system will fall back to a polling style approach without notification. Note that this url can be used along with the recordDefinition property of the instance to send data.
- Notification Content-Type: specifies the content type that the HTML POST request should use, either application/json or text/csv
- Max Records per Notification: number of records to push per HTTP request (between 0 and 50,000)
- Status on Notification: specifies what the member's status should be set to when a notification is set. This is only valid if Max Records per Notification is greater than 0.
When you're done configuring your AppCloud Action service, click Save. A green alert message will appear at the top of the page indicating the Service has been successfully saved.
