On this page:
Authentication Prerequisites
The Sendoso element uses the OAuth 2.0 authentication workflow. To provision an instance with the Sendoso element all you require is an OAuth API Key and OAuth API Secret. You need to send an email to hello@sendoso.com to receive these credentials.
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 Sendoso element, you will need the following parameters:
| Parameter Name/UI Value | API Value | Description | Source |
|---|---|---|---|
| OAuth API Key | oauth.api.key | Provided by Sendoso | Authentication Prerequisites |
| OAuth API Secret | oauth.api.secret | Provided by Sendoso | Authentication Prerequisites |
| OAuth Callback URL | oauth.callback.url | Default value is https://auth.cloudelements.io/oauth | Authenticate an Element Instance (API) |
Sample Configuration JSON
"configuration": {
"oauth.api.key": "[myApiKey]",
"oauth.api.secret": "[myApiSecret]",
"oauth.callback.url": "https://auth.cloudelements.io/oauth"
}Element Fact Sheet and Reference
Authentication and Configuration Parameters
To see all authentication parameters for the Sendoso 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 Sendoso element supports events via polling. 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 Sendoso element:
- groups
- return-addresses
- touches
Queryable Endpoints
You can use CEQL to query the following endpoints of the Sendoso element:
- GET /bulk/jobs
- GET /gifts
- GET /{objectName}
- GET /{objectName}/{objectId}/{childObjectName}
- GET /touches
- GET /journals
- GET /payments
- GET /purchase-orders
- GET /tax-rates
Element API Documentation
The base URL for all API requests is https://api.cloud-elements.com/elements/api-v2.
