Manage Elements includes steps to use Cloud Elements 2.0. The earlier version of Cloud Elements shares much of the same functionality. See documentation specific to that version at Element Builder.

Overview

Elements are enhanced connectors that provide a unified developer experience into a specific cloud application endpoint (e.g., Salesforce, Quickbooks, or Marketo). The Elements Catalog includes a list of all publicly available elements as well as any custom elements that you create. Use these elements to create authenticated connections — called element instances — to your API providers.

I addition to the Elements Catalog, we offer Element Builder to extend the capabilities of existing Cloud Elements integrations or build a new Element from scratch. If we don't have the element you're looking for, or if you want to extend any of the elements in the catalog, you can use Element Builder to extend and create elements.

Elements Catalog

The Elements Catalog shows a list of element cards that represent all of the elements available to you. Elements with your existing authenticated element instances appear at the top of the catalog. Each card shows the name and id of the element, the number of authenticated element instances, and the hub associated with the element. Elements Catalog

To work with an element, hover over the element card. You can authenticate an element instance, see the API docs associated with the element, export the element in JSON format, and add your own resources to the element.

You can also build your own custom elements. These include a private label because they are available only to users in your organization.

View Element API Docs

The API docs available for each element help you see what API request are available for each element. You can see descriptions of each request, descriptions of each field available for the requests, and which fields are required. The API docs are available in two different views: the default API docs and API docs associated with a specific instance. If you select an authenticated instance, you can interact with the docs to test your API requests or make actual requests.

To view API docs hover over the element card, and then click API Docs.

To make requests using the API docs:

  1. Select an authenticated instance on the left.
  2. Expand the endpoint that you want to make a request to.
  3. Click Try it Out.
  4. Supply any additional or required information.
  5. Click Execute.

Import and Export

You can export elements from the elements catalog in JSON format. This allows you to move elements that you build to different environments or make copies of public elements.

You can import elements from JSON, Swagger, or When you import an element, you can make changes to it, add resources, and configure advanced features like events and bulk.

To export an element:

  1. Hover over an element card, and then click Export. Export
  2. Save the JSON file to your computer.

To import an element:

  1. On the Elements page, click Build a New Element. Build Element
  2. Review the information on the Builder page, and then click Import.
  3. Select the type of file to import:
    • Element — A JSON file reated by exporting an element.
    • Swagger — A swagger specification file for an API.
    • SOAP — An XML file that describes a SOAP API.
    • OData — An Open Data Protocol file that describes a REST API.
  4. Select a file stored on your computer or enter the URL of the file.
  5. Click Next.
  6. Select the resources that you want to import.
  7. Click Import.
  8. Complete the element setup.