Recurly¶
The Recurly modules allow you to watch and create transactions and/or accounts in your Recurly account.
Prerequisites
- A Recurly account
In order to use Recurly with Ibexa Connect, it is necessary to have a Recurly account. If you do not have one, you can create a Recurly account at https://info.recurly.com/signup.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Recurly to Ibexa Connect¶
To connect your Recurly account to Ibexa Connect you need to obtain the API Key.
1. Log into your Recurly account.
2. From the left menu, click Integrations and then click API Credentials.
3. Copy the Default API Key or Click Add Private Key to create your own API key.
4. Go to Ibexa Connect and open the Recurly module's Create a connection dialog.
5. Enter the API Key copied in step 3 and click Continue.
The connection has been established.
Triggers¶
Watch Transactions¶
Triggers when a new transaction is created.
| Site | Select the site whose transactions you want to watch. |
| Limit | The maximum number of transactions Ibexa Connect should return during one scenario execution cycle. |
Watch Accounts¶
Triggers when a new customer account is created.
| Site | Select the site whose accounts you want to watch. |
| Limit | The maximum number of accounts Ibexa Connect should return during one scenario execution cycle. |
Actions¶
Create an Account¶
Create a new customer account.
Site |
Select the site whose transactions you want to watch. |
Code |
Enter the unique account code for the account. The account code cannot be changed once created. Must be 50 characters long. |
Username |
Enter the username for the account. |
Enter the email address for the account. |
|
First name |
Enter the first name of the account. |
Last name |
Enter the last name of the account. |
Phone |
Enter the phone number to be associated with the account. |
Street1 |
Enter the address of the customer. |
Street2 |
Enter the address of the customer. |
City |
Enter the city name the customer belongs to. |
State or Province |
Enter the state name the customer belongs to. |
Postal Code |
Enter the postal code of the place. |
Country |
Enter the country name of the customer. |
Company |
Enter the company name of the customer. |
VAT Number |
Enter the VAT number of the customer. |
This customer is exempt from the payment of tax |
Select Yes if the customer is given a tax exemption:
|
Preferred locale |
Select the preferred language of the customer. |
Make an API Call¶
Performs an arbitrary authorized API call.
Site |
Enter a path relative to | For the list of available endpoints, refer to the Recurly API Documentation. |
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of use - Sites¶
The following API call returns all sites in your account:
Matches of the search can be found in the module's Output under Bundle > Body > data. In our example, 1 site is returned:
