Endorsal¶
The Endorsal modules allow you to monitor, create, update, send, retrieve, list, archive, and delete the contacts, and testimonials in your Endorsal account.
Getting Started with Endorsal¶
Prerequisites
- An Endorsal account - create an account at endorsal.io/.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Endorsal to Ibexa Connect¶
To connect your Endorsal account to Ibexa Connect you need to obtain the API Key from your Endorsal account and insert it in the Create a connection dialog in the Ibexa Connect module.
-
Log in to your Endorsal account.
-
Click Your Profile Icon > API > Generate New API Key.
-
Copy the API Key to your clipboard.
-
Go to Ibexa Connect and open the Endorsal module's Create a connection dialog.
-
In the Connection name field, enter the connection name.
-
In the API Key field, enter the API key copied in step 3 and click Continue.
The connection has been established.
Contacts¶
List Contacts¶
Retrieves a list of contacts.
| Limit | Set the maximum number of contacts Ibexa Connect should return during one execution cycle. The default value is 10. |
Create a Contact¶
Creates a new contact.
Enter (map) the contact's email address. For example, |
|
Phone |
Enter (map) the contact's phone number. For example, |
Name |
Enter (map) the contact's name. |
External ID |
Enter (map) the contact's external ID of the platform from where the contact was imported. For example, |
Imported From |
Enter (map) the platform name from which the contact was imported. |
Avatar |
Enter (map) the URL address to the contact's profile image. |
Location |
Enter (map) the contact's location. For example, |
Position |
Enter (map) the contact's job title in the company. For example, |
Company |
Enter (map) the contact's company name. For example, |
Website |
Enter (map) the company's website URL address. |
Property ID |
Enter (map) the Property ID to which the contact belongs. |
Custom Attributes |
Add any additional attributes for the contact: Key Enter (map) the key name. For example, Value Enter (map) the key value. For example, first name is |
Get a Contact¶
Retrieves a contact.
| Contact ID | Select or map the Contact ID whose details you want to retrieve. |
Update a Contact¶
Updates a contact.
| Contact ID | Select or map the Contact ID whose details you want to update. |
| Name | Enter (map) the contact's name. |
Enter (map) the contact's email address. For example, [email protected]. |
Archive a Contact¶
Archives a contact.
| Contact ID | Select or map the Contact ID you want to archive. |
Testimonials¶
Watch New Testimonials¶
Triggers when a new testimonial has been created.
| Limit | Set the maximum number of testimonials Ibexa Connect should return during one execution cycle. The default value is 20. |
List Testimonials¶
Retrieves a list of testimonials.
| Limit | Set the maximum number of testimonials Ibexa Connect should return during one execution cycle. The default value is 10. |
Create a Testimonial¶
Creates a new testimonial.
Name |
Enter (map) the testimonial name. |
Comments |
Enter (map) additional comments for the testimonial. |
Property ID |
Enter (map) the Property ID applicable to the testimonial. |
Rating |
Select or map the rating of the testimonial between one and five. |
Avatar |
Enter (map) the URL address of the contact's profile image. |
Enter (map) the contact's email address applicable to the testimonial. For example, |
|
Location |
Enter (map) the contact's location who has provided the testimonial. For example, |
Position |
Enter (map) the contact position in the company. For example, |
Company |
Enter (map) the company name. For example, |
Approved |
Select or map the testimonial approval status:
|
Featured |
Select whether the testimonial is featured on the company's website:
|
Added |
Enter (map) the date the testimonial is added. See the list of supported date and time formats. |
Get a Testimonial¶
Retrieves a testimonial.
| Testimonial ID | Select or map the Testimonial ID whose details you want to retrieve. |
Update a Testimonial¶
Updates a testimonial.
Testimonial ID |
Select or map the Testimonial ID whose details you want to update. |
Name |
Enter (map) the testimonial name. |
Comments |
Enter (map) additional comments for the testimonial. |
Property ID |
Enter (map) the Property ID applicable to the testimonial. |
Rating |
Select or map the rating of the testimonial between one and five. |
Avatar |
Enter (map) the URL address of the contact's profile image. |
Enter (map) the contact's email address applicable to the testimonial. For example, |
|
Location |
Enter (map) the contact's location who has provided the testimonial. For example, |
Position |
Enter (map) the contact position in the company. For example, |
Company |
Enter (map) the company name. For example, |
Approved |
Select or map the testimonial approval status:
|
Featured |
Select whether the testimonial is featured on the company's website:
|
Added |
Enter (map) the date the testimonial is added. See the list of supported date and time formats. |
Delete a Testimonial¶
Deletes a testimonial.
| Testimonial ID | Select or map the Testimonial ID you want to delete. |
Other¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Endorsal 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 - List Testimonials¶
The following API call returns all the testimonials from your Endorsal account:
URL:
/v1/testimonials
Method:
GET
Matches of the search can be found in the module's Output under Bundle > Body > data.
In our example, 3 testimonials were returned:
