Agendor¶
With Agendor modules in Ibexa Connect, you can:
-
create, update, upsert, retrieve, search, and delete organizations
-
create, update, upsert, retrieve, search, and delete people
-
create, list, and delete products
-
create, update, retrieve, search, and lists deals for organization and persons
-
create and search tasks for a person, organization, and deal.
To get started with Agendor, create an account at agendor.com.
Connect Agendor to Ibexa Connect¶
To connect Agendor app, you need to obtain the API Key.
-
Log in to your Agendor account.
-
Click apps Menu > Integrations, and copy the API Key to a safe place.
-
Log in to your Ibexa Connect account, insert an Agendor module scenario and click the Add button next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the details copied in step 2 and click Save.
You have successfully connected the Agendor app and can now build scenarios.
Organizations¶
You can create, update, upsert, retrieve, search, and delete organizations using the following modules.
Create an Organization¶
Creates a new organization.
For field descriptions, see the Agendor Organization API reference.
Update an Organization¶
Updates an organization.
| Organization ID | Select or map the Organization ID whose details you want to update. |
For field descriptions, see the Agendor Organization API reference.
Upsert an Organization¶
Updates an organization or creates a new one if the organization does not exist.
| Name | Enter the Display name either to find (exact match) or create at most 150 characters long. |
For field descriptions, see the Agendor Organization API reference.
Get an Organization¶
Retrieves a specific organization.
| Organization ID | Select or map the Organization ID whose details you want to retrieve. |
Search Organization¶
Searches for organizations or lists them all.
| Limit | Set the maximum number of organizations Ibexa Connect will return during one execution cycle. The default value is 10. |
See Agendor Organization API reference for entering the field values to search the organizations that match the specified value.
Delete an Organization¶
Deletes an organization.
| Organization ID | Select or map the Organization ID you want to delete. |
People¶
You can create, update, upsert, retrieve, search, and delete people using the following modules.
Create a Person¶
Creates a new person.
For field descriptions, see the Agendor People API reference.
Update a Person¶
Updates a person.
| Person ID | Select or map the Person ID whose details you want to update. |
For field descriptions, see the Agendor People API reference.
Upsert a Person¶
Updates a person or creates a new one if the person does not exist.
| Person Name | Enter the Display name either to find (exact match) or create at most 150 characters long. |
For field descriptions, see the Agendor People API reference.
Get a Person¶
Retrieves a specific person.
| Person ID | Select or map the Person ID whose details you want to retrieve. |
Search Persons¶
Searches for persons or lists them all.
| Limit | Set the maximum number of persons Ibexa Connect will return during one execution cycle. The default value is 10. |
See Agendor People API reference for entering the field values to search the persons that match the specified value.
List Persons of an Organization¶
Retrieves a list of persons for a selected organization.
| Organization ID | Select or map the Organization ID whose persons you want to list. |
| Limit | Set the maximum number of persons Ibexa Connect will return during one execution cycle. The default value is 10. |
Delete a Person¶
Deletes a person.
| Person ID | Select or map the Person ID you want to retrieve. |
Products¶
You can create, list, and delete products using the following modules.
Create a Product¶
Creates a new product.
| Product Name | Enter the product name to create a product. |
For field descriptions, see the Agendor Product API reference.
List Products¶
Retrieves a list of products.
| Limit | Set the maximum number of products Ibexa Connect will return during one execution cycle. The default value is 10. |
For field descriptions, see the Agendor Product API reference.
Delete a Product¶
Deletes a product.
| Product ID | Select or map the Product ID you want to delete. |
Deals¶
You can create, update, retrieve, search, and lists deals for organization and persons using the following modules.
Create a Deal for an Organization¶
Creates a new deal for an organization.
For field descriptions, see the Agendor Deal API reference.
Create a Deal for a Person¶
Creates a new deal for a person.
For field descriptions, see the Agendor Deal API reference.
Update a Deal¶
Updates a deal.
| Deal ID | Select or map the Deal ID whose details you want to update. |
For field descriptions, see the Agendor Deal API reference.
Update a Deal Status¶
Updates a deal status.
| Deal ID | Select or map the Deal ID whose status you want to update. |
For field descriptions, see the Agendor Deal API reference.
Update a Deal Stage¶
Updates a deal stage.
| Deal ID | Select or map the Deal ID whose stage you want to update. |
| Deal Stage Sequence Number | Select the deal stage sequence number. For example, follow-up. |
Get a Deal¶
Retrieves a specific deal.
| Deal ID | Select or map the Deal ID whose details you want to retrieve. |
List Deals of an Organization¶
Retrieves a list of deals for a selected organization.
| Organization ID | Select or map the Organization ID whose deals you want to list. |
| Limit | Set the maximum number of deals of an organization Ibexa Connect will return during one execution cycle. The default value is 10. |
List Deals of a Person¶
Retrieves a list of deals for a selected person.
| Person ID | Select or map the Person ID whose details you want to list. |
| Limit | Set the maximum number of deals for a person Ibexa Connect will return during one execution cycle. The default value is 10. |
Search Deals¶
Searches for deals or lists them all.
| Limit | Set the maximum number of deals Ibexa Connect will return during one execution cycle. The default value is 10. |
See Agendor Deal API reference for entering the field values to search the deals that match the specified value.
Tasks¶
You can create and search tasks for a person, organization, and deal using the following modules.
Create a Task for a Person¶
Creates a new task for a person.
For field descriptions, see the Agendor Task API reference.
Create a Task for an Organization¶
Creates a new task for an organization.
For field descriptions, see the Agendor Task API reference.
Create a Task for a Deal¶
Creates a new task for a deal.
For field descriptions, see the Agendor Task API reference.
Search a Task of a Person¶
Searches for tasks for a selected person or lists them all.
| Limit | Set the maximum number of tasks for a person Ibexa Connect will return during one execution cycle. The default value is 10. |
See Agendor Task API reference for entering the field values to search for the task that matches the specified value.
Search a Task of an Organization¶
Searches for tasks for a selected organization or lists them all.
| Limit | Set the maximum number of tasks of an organization Ibexa Connect will return during one execution cycle. The default value is 10. |
See Agendor Task API reference for entering the field values to search the tasks that match the specified value.
Search Tasks of a Deal¶
Searches for tasks for a selected deal or lists them all.
| Limit | Set the maximum number of tasks of a deal Ibexa Connect will return during one execution cycle. The default value is 10. |
See Agendor Task API reference for entering the field values to search the task deal that matches the specified value.
Search Tasks¶
Searches for tasks or lists them all.
| Limit | Set the maximum number of tasks Ibexa Connect will return during one execution cycle. The default value is 10. |
See Agendor Task API reference for entering the field values to search for the task that matches the specified value.
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 Agendor API documentation.
URL |
Enter a path relative to |
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 - List Products¶
The following API call returns all products from your Agendor account.
URL: /v3/products
Method: GET
The search matches can be found in the module's Output under Bundle > Body > data.
In our example 5 products were returned:
