Element Documentation Template v2

The [ELEMENT_NAME] element is available in the [HUB_NAME] hub.

Authentication Prerequisites

The [ELEMENT_NAME] element uses the OAuth 2.0 authentication workflow. Before you can authenticate an instance of the [ELEMENT_NAME] element, you need the following: [THE FOLLOWING ARE ALL PLACEHOLDERS AND MAY NOT APPLY, EG PROVIDER SANDBOX. THERE MAY ALSO BE MORE THAN TWO AUTH PREREQS]

Provider sandbox [update as needed]

A trial or paid [ELEMENT_NAME] account and sandbox are required.

[Auth prerequisite 1]

To generate or retrieve OAuth credentials for your [ENDPOINT_NAME] account, follow these steps:

Step
Step
Step

[Auth prerequisite 2]

To complete this prerequisite, follow these steps:

Step
Step
Step

Required Authentication Parameters

You can authenticate an element instance using the UI or via API calls. For detailed information on how to authenticate an instance, see our related documentation:

To authenticate an instance of the [ELEMENT_NAME] element, you will need the following parameters:

Parameter Name/UI Value	API Value	Description	Source
Name	name	The name of your element instance	n/a

Sample Configuration JSON

"configuration": {
    "[PARAMETER_1]": "[parameter1]",
    "[PARAMETER_2]": "[parameter2]",
    "[PARAMETER_3]": "[parameter3]",
    "oauth.callback.url": "[http://my.callback.url]"
  }

Element Fact Sheet and Reference

Authentication and Configuration Parameters

To see all authentication parameters for the [ELEMENT_NAME] element, follow these steps:

Sign in to Cloud Elements and navigate to Elements.
Hover over the card for an element, and then click My Resources.
In the top navigation toolbar, click Setup.
From the Setup page, you can view a complete list of the element's authentication and configuration parameters.

Events and Supported Resources

The [ELEMENT_NAME] element supports events via webhooks. For detailed information about our Events framework and how to configure an element instance with events, see our documentation:

You can set up polling events for the following resources of the [ELEMENT_NAME] element:

[LIST_OF_EVENT_CONFIG_PARAMETERS]

Objects and Supported Operations

Object	Operations	Bulk Support (y/n)
[OBJECT_1]	GET /accounts POST /accounts GET /accounts/{id}	Y
[OBJECT_2]	GET /contacts POST /contacts GET /contacts/{id}	Y
[OBJECT_3]	GET /credit-notes POST /credit-notes GET /credit-notes/{id}	Y
ETC

Queryable Endpoints

You can use CEQL to query the following endpoints of the [ELEMENT_NAME] element:

GET /endpoint1
GET /endpoint2
GET /endpoint3/{id}

{{Snippet.termelementucsingular}} API Documentation

[UPDATE elementid IN BELOW SWAGGERDOCSUI SNIPPET] The base URL for all API requests is https://api.cloud-elements.com/elements/api-v2.

On this page: