Aprimo

Overview

Events

• Webhook - MO

  Aprimo - Marketing Operations webhook event. Listen for events defined in Aprimo, that will trigger the Flow in real time.

  Instructions

  1. In order to create an Aprimo Webhook, you will first need an accessible URL endpoint before configuring the Webhook in Aprimo. This can be done by creating a Flow using this webhook, and then save the Flow. Click the ‘Webhook settings’ button at the bottom right of this card. This will present you with the Webhook URL. Copy the URL.
  2. Provide the URL when configuring your Aprimo Webhook.
  3. Once you have created your webhook in Aprimo, you should then be provided with a Webhook secret or key. Enter this value as the ‘Webhook Secret’ option.
  4. Trigger your webhook.

  Options

  • Webhook Secret (string): Enter an Aprimo webhook secret/key. This is provided by Aprimo when your webhook is created.

  Output Fields

  • Output
    • Title (string): is the readable name for the CalloutLocation.
    • Id (string): Record ID
    • ObjectTypeId (number): The Aprimo Object ID for creates, updates, or deletes on an Aprimo object, or 9963 for task status actions.
    • ObjectResourceName (string): The Aprimo Object resource name.
    • ObjectId (number): The ID of record that triggered the webhook.
    • CreatingUserId (number): The Aprimo User Id of the user who triggered the event. This may be an actual user of the system or a service user if the event was triggered by an automated process.
    • EventTime (string): The time the event originally occurred in UTC.
    • EventId (string): A unique ID for the event, consistent through any retries.
    • CalloutLocation (number): indicates the type of webhook in integer form.
    • DatasourceId (number): An internal value used by Aprimo for diagnostic purposes.
    • CalloutType (number): The Aprimo Object ID for creates, updates, or deletes on an Aprimo object, or an Aprimo webhook ID if triggered from a task status action.
    • RetryCount (number): The retry count of this message.
    • Body (string): An ID used by Aprimo for diagnostic purposes.
    • Project_Id (string): The project ID associated with the task that triggered the status action.
    • Step_type (string): The workflow step type associated to the task. Different step types may require different REST API calls to get additional data (for example, a review task may have more information than a basic task).
    • Test_mode (string): Test mode may be turned on when configuring a workflow status action in the Aprimo workflow designer. This can be used by the receiving service to decide to take actions if workflows are still being tested.
  • Raw
    • headers (object): Raw headers that are sent in the Webhook request.
    • body (object): Raw body that is sent in the Webhook request.
  • HMAC Validation
    • Status (boolean): The status of the HMAC validation. True if it was validated successfully, and false if it was not validated successfully.
    • Response Code (number): The status code that was returned to Aprimo based on the validation status. Returns a 200 if the validation was successful, and 400 if it was not successful.

Actions

• Custom API Action - DAM

  Make a custom HTTP Request to the Aprimo Digital Asset Managemnt (DAM) API.

  Aprimo DAM API Docs: https://training3.dam.aprimo.com/api/core/docs

  Options

  • Request Type (dropdown) - Available HTTP Request Methods. Choose from GET, POST, PUT, and DELETE. Refer to API docs in order to determine which request type to use.
    • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.
    • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. If a POST is successful, you will receive a 200 OK response message. Additional documentation here.
    • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Additional documentation here.
    • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Additional documentation here.

  Input Fields

  • Request

    • Relative URL (string) - Relative request URL. The relative URL structure for this action follows the /api/core route. E.g. - If the full API URL is https://example-subdomain.dam.aprimo.com/api/core/collections, then the Relative URL would be /collections.

      Example: /collections

    • Query (object) - Query parmaeters for the request.

      Example: {"record_type":"documentation"}

    • Headers (object) - Headers for the request.

      Example: {"Accept":"application/json"}

    • Body (object) (only for POST, PUT, and DELETE) - Body of the request.

      Example: {"foo": "automation, "bar": "integration"}

  Output Fields

  • Response
    • Status Code (number) - The status code of the HTTP response. Here is a list of all status codes.
    • Headers (object) - The response headers. A more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you.
    • Body (object) - The response body. Depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.

• Custom API Action - MO

  Make a custom HTTP Request to the Aprimo Marketing Operations (MO) API.

  Aprimo Marketing Operations API Docs: https://developers.aprimo.com/marketing-operations/rest-api/

  Options

  • Request Type (dropdown) - Available HTTP Request Methods. Choose from GET, POST, PUT, and DELETE. Refer to API docs in order to determine which request type to use.
    • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.
    • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. Additional documentation here.
    • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. Additional documentation here.
    • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). Additional documentation here.

  Input Fields

  • Request

    • Relative URL (string) - Relative request URL. The relative URL structure for this action follows the /api route. E.g. - If the full API URL is https://example-subdomain.aprimo.com/api/activities, then the Relative URL would be /activities.

      Example: /activities

    • Query (object) - Query parmaeters for the request.

      Example: {"record_type":"documentation"}

    • Headers (object) - Headers for the request.

      Example: {"Accept":"application/json"}

    • Body (object) (only for POST, PUT, and DELETE) - Body of the request.

      Example: {"foo": "automation, "bar": "integration"}

  Output Fields

  • Response
    • Status Code (number) - The status code of the HTTP response. Here is a list of all status codes.
    • Headers (object) - The response headers. A more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you.
    • Body (object) - The response body. Depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.

• Download File from URL - MO

  Download a file from Aprimo’s Marketing Operations service by a file URL/URI.

  Input Fields

  • File

    • URL (string) - The file URL or URI. This should be a direct download link.

      Example: https://training3.aprimo.com/AprimoPortal/FileStore.ashx/Attachment/303/_/_/a61747480b0ade64bf1234f0fb605cf287fb0cc8108373f938c43c0d44b27d19777cbe1d9b34809d04edf32142478bdf7abc1752e0d58w54e163674df7c296f6/pexels-photo-185576.jpeg

  Output Fields

  • Output
    • File Content (file) - The downloaded file content. This can be downloaded directly from the UI by clicking on the File Content link in execution history, or you can use this File Content to upload the file to subsequent file systems.

• Upload File - DAM

  Upload a file to Aprimo’s Digital Asset Management service.

  Input Fields

  • File
    • File Content (file): File content downloaded from a previous step in the Flow.
    • Chunk Size (MB) (number): The size of each multipart chunk in megabytes that will be uploaded to Aprimo. This must be between 1 and 25. A larger value will upload quicker, and vice versa.
    • Concurrency (number): The number of concurrent multipart uploads that will process in parallel. For example, if you set the Chunk Size to 20MB, and the concurrency to 1, it will upload one 20MB chunk at a time. Concurrency of three would upload three 20MB chunks at a time, etc. This value must be between 1-10.

  Output Fields

  • Output
    • File Upload Token (string): The file upload token returned from Aprimo once the upload has succeeded. Use this token in subsequent API requests to update / add to a record.

• Upload File - MO

  Upload a file to Aprimo’s Marketing Operations service.

  Input Fields

  • File
    • File Content (file): File content downloaded from a previous step in the Flow.
    • Chunk Size (MB) (number): The size of each multipart chunk in megabytes that will be uploaded to Aprimo. This must be between 1 and 25. A larger value will upload quicker, and vice versa.
    • Concurrency (number): The number of concurrent multipart uploads that will process in parallel. For example, if you set the Chunk Size to 20MB, and the concurrency to 1, it will upload one 20MB chunk at a time. Concurrency of three would upload three 20MB chunks at a time, etc. This value must be between 1-3.

  Output Fields

  In order to attach an uploaded file to a record, such as attachments, digital assets, thumbnails, etc - use the following fields in a subsequent request.

  • Output
    • FileId (string): The ID of the file in Aprimo’s Marketing Operations file system.
    • FileName (string): The name of the file in Aprimo’s Marketing Operations file system.