Creating Accounts and Managing Account Settings
Now that you understand the importance of Accounts in Cyclr, it’s time to dive into how to create and manage them. In this lesson, we’ll take you through the process of setting up a new Account in Cyclr’s Partner Console.
We’ll also cover the key settings that allow you to tailor each Account to your customers’ specific needs.
How to Create a New Account
You can create new Accounts in Cyclr either manually in the Console, via the API or as part of the marketplace flow.
Creating an Account Manually in the Partner Console
Here is how you can create a new Account manually from your Partner Console. We have a short video available on how to create an account in our “Introduction to the Cyclr Console“ tutorial, so feel free to check it our. Here is the same process explained in writing:
- Navigate to Account Management
- In your Partner Console, from the navigation panel on the left hand side, go to Accounts > Account Management. This is where you’ll find and manage all of your customers’ Accounts.
- In your Partner Console, from the navigation panel on the left hand side, go to Accounts > Account Management. This is where you’ll find and manage all of your customers’ Accounts.
- Click on the “Add New Account” button
- You can find it at the top of the Account Management page.
- You can find it at the top of the Account Management page.
- Fill in the Account Information
- You’ll be prompted to enter some key details for the new Account. You can find the breakdown of each field below.
- Once done, click on “Save”.
Account Settings:
| Property | Description |
|---|---|
| API ID | Enables you to provide a custom unique identifier for an Account. This will be used as the X-Cyclr-Account HTTP Header when making calls to Cyclr’s API to set the Account context being worked in. This could be, for example, the same unique identifier you have in your own application that identifies a customer. If left blank, Cyclr will input its own unique internal “ID” value for this. |
| Name | A way to identify an Account through Cyclr’s interface and within reporting. |
| Description | Additional information about an Account. |
| Timezones | The timezone to use when displaying date/time values within the Account. |
| Next Billing Date | Optional field |
| Account Audit Info | Allows you to enter additional information about an Account for your own reference. |
| Task Audit Info | Allows you to enter additional information about an Account for your own reference. |
| Concurrent Transaction Limit | Overrides the Console-level setting. Set the maximum number of Transactions that Cyclr will process within the Account at a time. Can be used to reduce the speed at which Cyclr processes the Transactions within an Account. |
| Successful Transaction Data Retention | Overrides the Console-level setting. Allows you to specify how long successful transactions are kept. |
| Errored Transaction Data Retention | Overrides the Console-level setting. Allows you to specify how long failed transactions are kept. |
| Transaction Error Webhook | Overrides the Console-level setting. Makes an HTTP call to a specified URL when an error occurs in a transaction. |
Creating an Account via the Cyclr API
You can also create Accounts in Cyclr programmatically via the Cyclr API.
Creating Accounts programmatically can save you and your development team a lot of time. It allows you to automate the Account creation process, as you don’t need to open a new Account manually each time you gain a new Account in your application.
To create an Account via the Cyclr API requires you to make a POST call to the POST /v1.0/Accounts endpoint. The available request and response fields are covered in our documentation here, but they are also detailed below for your convenience.
Request:
POST /v1.0/Accounts
Authorization: Bearer 0000000000000000000000000000000000000000000000000000000000000000
{
"Name": "Test Account 001",
"Description": "An Account we will use for testing",
"Timezone": "Europe/London",
"StepDataSuccessRetentionHours": 168,
"StepDataErroredRetentionHours": 336,
"TransactionErrorWebhookEnabled": true,
"TransactionErrorWebhookUrl": "https://webhook/path/here",
"TransactionErrorWebhookIncludeWarnings": false
}Response:
200 Ok
{
"CreatedDate": "2017-12-06T15:54:06.6440352Z"
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "Test Account 001",
"Description": "An Account we will use for testing",
"AuditInfo": null,
"TaskAuditInfo": null,
"Timezone": "Europe/London",
"NextBillDateUtc": "2022-12-14T11:00:55.4629051Z",
"StepDataSuccessRetentionHours": 168,
"StepDataErroredRetentionHours": 336,
"TransactionErrorWebhookEnabled": true,
"TransactionErrorWebhookUrl": "https://webhook/path/here",
"TransactionErrorWebhookIncludeWarnings": false
}
Creating Accounts via Marketplaces
If you are using a Cyclr Marketplace in your application or service as a way for your customers to self-serve integrations, you can create Accounts as part of the marketplace flow.
There are two ways to deploy Cyclr’s Marketplaces, and the deployment method you should choose depends on whether you intend to give your customers direct access to Cyclr. You can review both methods with full explanations of all the request and response fields in our documentation here: Deploy a Marketplace.
Account Management Deployment
Account Management Deployment is a deployment method for Cyclr Marketplaces that allows you to give your customers a way to self-serve their integrations without providing them direct access to Cyclr.
Essentially, with this deployment method, you create a button inside your own application’s user interface that takes your customers to the Marketplace. On the button click, you need to:
- Make a request from your application server to the Cyclr API’s
/v1.0/accounts/{id}/marketplaceendpoint to obtain a Marketplace URL. For more information about this endpoint, see the Interactive API reference page. - Direct the user to the URL in their web browser, perhaps within an iframe.
In the request you need to pass a CYCLR_ACCOUNT_API_ID parameter that specifies the account to use. If an account with this API ID doesn’t exist, Cyclr creates a new account using this value.
The full request and response formats and all parameters are available in our Deploy a Marketplace documentation.
It’s important to note that when you deploy a Marketplace, an API User will be created in your Cyclr Partner Console under Accounts > Account Management. This API User has access to the Account, but can’t sign in to the Cyclr interface.
Managing Account Settings
Once an account is created, you can always manage, change and update it’s settings by going back to Account Management in your Partner Console.
Find the account you want to manage and access the account’s settings from the “Edit” button. This is where you can change the Account settings when needed.
Here are some of the key settings that depend largely on your customer’s needs, and can be used to override your Console-level settings:
- Concurrent Transaction Limit:
- This setting determines how many actions (or “transactions”) Cyclr can process for this Account at once. By default, this limit is inherited from the Console-level settings, but you can adjust it if needed.
- For example, if a customer has lower traffic or simpler workflows, you might want to limit the number of transactions to avoid overwhelming their system. On the other hand, a customer with high-volume integrations might need a higher transaction limit.
- Successful Transaction Data Retention:
- Cyclr lets you define how long successful transaction records are stored. Depending on your customer’s needs, you might want to keep records for auditing purposes or delete them after a certain period to save space.
- Cyclr lets you define how long successful transaction records are stored. Depending on your customer’s needs, you might want to keep records for auditing purposes or delete them after a certain period to save space.
- Errored Transaction Data Retention:
- Similarly, you can decide how long to keep records of failed transactions. This helps with troubleshooting issues, as you can review errors that have occurred within a specific timeframe.
- Similarly, you can decide how long to keep records of failed transactions. This helps with troubleshooting issues, as you can review errors that have occurred within a specific timeframe.
- Transaction Error Webhooks:
- If you want to be notified when an error occurs during a transaction, you can set up a webhook. Cyclr will send an HTTP request to the specified URL whenever a transaction fails, allowing you to track and resolve issues more quickly.
Key Takeaways
In this lesson, you’ve learned the multiple ways you can create new Accounts in Cyclr and how to manage their settings. By customizing transaction limits, data retention policies, and error notifications, you can ensure each customer’s Account operates smoothly and fits their specific needs.
- Transaction Limits: Adjust the speed and volume at which Cyclr processes tasks for your customers.
- Data Retention: Set different retention periods for successful and errored transactions, ensuring each customer’s data storage meets their specific needs.
- Error Webhooks: Set up automatic notifications for transaction failures to stay on top of any issues.