• Documentation >
• Apps >
• Marketing >
• Raklet

Raklet

With Raklet modules in Ibexa Connect, you can:

• watch new payments

• watch, create, update, search, and retrieve contacts, add tags and notes on a contact

• update, list, retrieve, and delete contact notes

• create, update, retrieve, search, delete, and remove tags from the contact

To get started with Raklet, create an account at raklet.com.

Connect Raklet to Ibexa Connect

To connect Raklet app, you need to obtain the credentials of your Raklet account and insert them in the Raklet module scenario.

1. Log in to your Ibexa Connect account, open a Raklet module scenario and click the Add button next to the Connection field.

   

2. In the Connection name field, enter a name for the connection.

3. In the Email and Password fields, enter your Raklet account credentials and click Save.

You have successfully established the connection. You can now begin editing your scenario and adding more Raklet modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Payments

You can watch the new payments using the following modules.

Watch New Payment

Triggers when a new payment has been processed.

Organization ID	Select or map the Organization ID whose contacts payments you want to watch.
Contact ID	Select or map the contact ID whose payments you want to watch.
Limit	Set the maximum number of payments Ibexa Connect will return during one execution cycle. The default value is 10.

Contacts

You can watch, create, update, search, and retrieve contacts, and add tags and notes on a contact using the following modules.

Watch New Contact

Triggers when a new contact has been created.

Organization ID	Select or map the Organization ID whose contacts you want to watch.
Limit	Set the maximum number of contacts Ibexa Connect will return during one execution cycle. The default value is 10.

Search Contacts

Searches for contacts or lists them all.

Limit	Set the maximum number of contacts Ibexa Connect will return during one execution cycle. The default value is 10.

See Raklet Contacts API reference for entering the field values to search the contacts that match the specified value.

Get a Contact

Retrieves a contact.

Organization ID	Select or map the Organization ID whose contact you want to retrieve.
Contact ID	Select or map the Contact ID whose details you want to retrieve.

Create a Contact

Creates a new contact.

For field descriptions, see the Raklet Contacts API reference.

Update a Contact

Updatesa contact.

Contact ID	Select or map the Contact ID whose details you want to update.

For field descriptions, see the Raklet Contacts API reference.

Delete a Contact

Deletes a contact.

Organization ID	Select or map the Organization ID whose contact you want to delete.
Contact ID	Select or map the Contact ID you want to delete.

Add a Tag on a Contact

Adds a tag on a contact.

Organization ID	Select or map the Organization ID to whose contacts you want to add a tag.
Tag ID	Select or map the Tag ID you want to add.
Contact IDs	Select or map the Contact ID to which you want to add a tag.

Add a Note on a Contact

Adds a note on a contact.

Organization ID	Select or map the Organization ID to whose contacts you want to add a note.
Contact ID	Select or map the Contact ID to which you want to add a note.
Note Text	Enter the note text.

Contact Notes

You can update, list, retrieve, and delete contact notes using the following modules.

List Contact Notes

Retrieves contact notes.

Organization ID	Select or map the Organization ID whose contact notes you want to list.
Contact ID	Select or map the Contact ID whose notes you want to list.

Get a Contact Note

Retrieves a contact note.

Organization ID	Select or map the Organization ID whose contact note details you want to retrieve.
Contact ID	Select or map the Contact ID whose note details you want to retrieve.
Note ID	Select or map the Note ID whose details you want to retrieve.

Update a Contact Note

Updates a contact note.

For field descriptions, see the Raklet Contact Notes API reference.

Delete a Contact Note

Deletes a contact note.

Organization ID	Select or map the Organization ID whose contact note you want to delete.
Contact ID	Select or map the Contact ID whose note you want to delete.
Note ID	Select or map the Note ID you want to delete.

Tags

You can create, update, retrieve, search, delete, and remove a tag from contact using the following modules.

Search Tags

Searches for tags or lists them all.

Limit	Set the maximum number of tags Ibexa Connect will return during one execution cycle. The default value is 10.

See Raklet Tags API reference for entering the field values to search the contacts that match the specified value.

Remove a Tag from a Contact

Removes a tag from the selected contact.

Organization ID	Select or map the Organization ID whose contact tag you want to remove.
Tag ID	Select or map the Tag ID you want to remove.
Contact IDs	Select or map the Contact ID from which you want to remove the tag.

Create a Tag

Creates a new tag.

For field descriptions, see the Raklet Tags API reference.

Get a Tag

Retrieves a tag.

Organization ID	Select or map the Organization ID whose tags you want to retrieve.
Tag ID	Select or map the Tag ID whose details you want to retrieve.

Update a Tag

Updates a tag.

Tag ID	Select or map the Tag ID whose details you want to update.

For field descriptions, see the Raklet Tags API reference.

Delete a Tag

Deletes a tag.

Organization ID	Select or map the Organization ID whose tags you want to delete.
Tag ID	Select or map the Tag ID you want to delete.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the Raklet API documentation.

URL	Enter a path relative to https://api.raklet.com. For example, /account/user.
Method	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 - Search Contacts

The following API call returns all contacts from your account.

URL: /organisations/{organisationId}/contacts

Method: GET

The search matches can be found in the module's Output under Bundle > Body > Data.

In our example 5 contacts were returned: