Requirements
Ploomes requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]
Get your Ploomes credentials
- API KeypasswordRequired
In your account, navigate to Administration -> Integrations Users -> Create a new user and copy the API Key.
[1]
Connect Ploomes in WEXTL
- Log in to your WEXTL account, add the Ploomes node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Ploomes account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Ploomes node modules
The list below is a reference of every Ploomes node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Ploomes node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch ContactsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Type ID | number |
| Name | text |
| Legal name | text |
| Register | text |
| CNPJ | text |
| CNPJ | text |
| Status ID | number |
| Company ID | text |
| Relationship ID | text |
| Line of business ID | text |
| Origin ID | text |
| Number of employees ID | text |
| Class ID | number |
| Owner ID | number |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Note | text |
50other output fields
Watch DealsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Account ID | number |
| Contact ID | number |
| Contact name | text |
| Person ID | text |
| Person name | text |
| Pipeline ID | number |
| Stage ID | number |
| Status ID | number |
| First task ID | text |
| First task date | text |
| First task no time | text |
| Has scheduled tasks | boolean |
| Tasks ordination | number |
| Contact product ID | text |
| Last quote ID | text |
| Is last quote approved | boolean |
| Won quote ID | text |
| Last stage ID | text |
38other output fields
Watch DocumentsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Title | text |
Watch EventsTrigger
No fields documented.
Watch OrdersTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Contact ID | number |
| Products | array |
| Currency ID | number |
| Amount | number |
| Other properties | array |
Watch ProductsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Group ID | number |
| Family ID | text |
| Name | text |
| Code | text |
| Measurement unit | text |
| Image URL | url |
| Currency ID | text |
| Unit price | number |
| Create import ID | text |
| Update import ID | text |
| Editable | boolean |
| Deletable | boolean |
| Suspended | boolean |
| Creator ID | number |
| Updater ID | text |
| Create date | date |
| Last update date | date |
| Importation ID create | text |
| Importation ID update | text |
Watch QuotesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Contact ID | number |
| Account ID | number |
| Contact name | text |
| Deal ID | number |
| Owner ID | number |
| Template ID | number |
| Is template | boolean |
| Date | text |
| Quote number | number |
| Review number | number |
| Last review | boolean |
| Last review ID | number |
| Approver | boolean |
| Approval status ID | text |
| Approval level ID | text |
| Person ID | text |
| Person name | text |
| Currency ID | number |
| Amount | number |
40other output fields
Watch TasksTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Description | text |
| Date time | date |
| Contact ID | number |
| Other properties | array |
Search ContactsSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter Criteria | text |
| Custom Filter | text |
| Order By | choice |
| Expand | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Type ID | number |
| Name | text |
| Legal name | text |
| Register | text |
| CNPJ | text |
| CNPJ | text |
| Status ID | number |
| Company ID | text |
| Relationship ID | text |
| Line of business ID | text |
| Origin ID | text |
| Number of employees ID | text |
| Class ID | number |
| Owner ID | number |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Note | text |
50other output fields
Search DealsSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter Criteria | text |
| Custom Filter | text |
| Order By | choice |
| Expand | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Account ID | number |
| Contact ID | number |
| Contact name | text |
| Person ID | text |
| Person name | text |
| Pipeline ID | number |
| Stage ID | number |
| Status ID | number |
| First task ID | text |
| First task date | text |
| First task no time | text |
| Has scheduled tasks | boolean |
| Tasks ordination | number |
| Contact product ID | text |
| Last quote ID | text |
| Is last quote approved | boolean |
| Won quote ID | text |
| Last stage ID | text |
38other output fields
Search DocumentsSearch
Search OrdersSearch
Search ProductsSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter Criteria | text |
| Custom Filter | text |
| Order By | choice |
| Expand | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Group ID | number |
| Family ID | text |
| Name | text |
| Code | text |
| Measurement unit | text |
| Image URL | url |
| Currency ID | text |
| Unit price | number |
| Create import ID | text |
| Update import ID | text |
| Editable | boolean |
| Deletable | boolean |
| Suspended | boolean |
| Creator ID | number |
| Updater ID | text |
| Create date | date |
| Last update date | date |
| Importation ID create | text |
| Importation ID update | text |
Search QuotesSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter Criteria | text |
| Custom Filter | text |
| Order By | choice |
| Expand | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Contact ID | number |
| Account ID | number |
| Contact name | text |
| Deal ID | number |
| Owner ID | number |
| Template ID | number |
| Is template | boolean |
| Date | text |
| Quote number | number |
| Review number | number |
| Last review | boolean |
| Last review ID | number |
| Approver | boolean |
| Approval status ID | text |
| Approval level ID | text |
| Person ID | text |
| Person name | text |
| Currency ID | number |
| Amount | number |
40other output fields
Search TasksSearch
Search UsersSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter Criteria | text |
| Custom Filter | text |
| Order By | choice |
| Expand | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Account ID | number |
| Name | text |
| text | |
| Phone | text |
| Avatar URL | url |
| Role ID | text |
| Profile ID | number |
| text | |
| Linked in | text |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Integration | boolean |
| Native integration | boolean |
| Google authenticator configured | text |
| User key | text |
| Last login | text |
| Frequency | text |
| Account owner | boolean |
21other output fields
Create a ContactAction
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
| Neighborhood | text |
| Owner ID | choice |
| Note | text |
| CNPJ | text |
| Cnae code | text |
| Cnae name | text |
| Cnae secondary | text |
| Latitude | text |
| Longitude | text |
| Website | url |
| Avatar URL | url |
| Zip Code | number |
| Key | text |
| Register | text |
| City ID | choice |
| State ID | choice |
| Country ID | choice |
| Currency ID | choice |
20other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Type ID | number |
| Name | text |
| Legal name | text |
| Register | text |
| CNPJ | text |
| Status ID | number |
| Company ID | text |
| Relationship ID | text |
| Line of business ID | text |
| Origin ID | text |
| Number of employees ID | text |
| Class ID | number |
| Owner ID | number |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Note | text |
| text | |
| Website | text |
49other output fields
Create a DealAction
Input fields[3]
| Field | Type |
|---|---|
TitleRequired | text |
| Contact ID | choice |
| Amount | number |
| Stage ID | choice |
| Other Properties | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Type ID | number |
| Name | text |
| Legal name | text |
| Register | text |
| CNPJ | text |
| CNPJ | text |
| Status ID | number |
| Company ID | text |
| Relationship ID | text |
| Line of business ID | text |
| Origin ID | text |
| Number of employees ID | text |
| Class ID | number |
| Owner ID | number |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Note | text |
| text |
50other output fields
Create a DocumentAction
Create a ProductAction
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
| Group ID | choice |
| Family ID | choice |
| Product Code | text |
| Measurement Unit | text |
| Image URL | url |
| Currency ID | choice |
| Unit Price | number |
| Create Import ID | number |
| Update Import ID | number |
| Editable | boolean |
| Deletable | boolean |
| Suspended | boolean |
| Creator ID | choice |
| Updater ID | choice |
| Creation Date | date |
| Last Update Date | date |
| Importation ID on Create | number |
| Importation ID on Update | number |
| Other Properties | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Group ID | number |
| Family ID | text |
| Name | text |
| Code | text |
| Measurement unit | text |
| Image URL | url |
| Currency ID | text |
| Unit price | number |
| Create import ID | text |
| Update import ID | text |
| Editable | boolean |
| Deletable | boolean |
| Suspended | boolean |
| Creator ID | number |
| Updater ID | text |
| Create date | date |
| Last update date | date |
| Importation ID create | text |
| Importation ID update | text |
Create a QuoteAction
Input fields[3]
| Field | Type |
|---|---|
| Deal | object |
TitleRequired | text |
| Contact ID | choice |
| Template ID | choice |
| Sections | array |
| Currency ID | choice |
| Amount | number |
| Other Properties | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Contact ID | number |
| Account ID | number |
| Contact name | text |
| Deal ID | number |
| Owner ID | number |
| Template ID | number |
| Is template | boolean |
| Date | text |
| Quote number | number |
| Review number | number |
| Last review | boolean |
| Last review ID | number |
| Approver | boolean |
| Approval status ID | text |
| Approval level ID | text |
| Person ID | text |
| Person name | text |
| Currency ID | number |
| Amount | number |
40other output fields
Create a Review in a QuoteAction
Input fields[3]
| Field | Type |
|---|---|
Quote IDRequired | choice |
| Sections | array |
| Currency ID | choice |
| Amount | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Contact ID | number |
| Account ID | number |
| Contact name | text |
| Deal ID | number |
| Owner ID | number |
| Template ID | number |
| Is template | boolean |
| Date | text |
| Quote number | number |
| Review number | number |
| Last review | boolean |
| Last review ID | number |
| Approver | boolean |
| Approval status ID | text |
| Approval level ID | text |
| Person ID | text |
| Person name | text |
| Currency ID | number |
| Amount | number |
40other output fields
Create a TaskAction
Create a UserAction
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
EmailRequired | |
| Profile ID | choice |
| Password | text |
| Other Properties | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Account ID | number |
| Name | text |
| text | |
| Phone | text |
| Avatar URL | url |
| Role ID | text |
| Profile ID | number |
| text | |
| Linked in | text |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Integration | boolean |
| Native integration | boolean |
| Google authenticator configured | text |
| User key | text |
| Last login | text |
| Frequency | text |
| Account owner | boolean |
21other output fields
Create an OrderAction
Delete a ContactAction
Input fields[3]
| Field | Type |
|---|---|
Contact IDRequired | choice |
Delete a DealAction
Input fields[3]
| Field | Type |
|---|---|
Deal IDRequired | choice |
Delete a DocumentAction
Input fields[3]
| Field | Type |
|---|---|
Document IDRequired | choice |
Delete a ProductAction
Input fields[3]
| Field | Type |
|---|---|
Product IDRequired | choice |
Delete a QuoteAction
Input fields[3]
| Field | Type |
|---|---|
Quote IDRequired | choice |
Delete a TaskAction
Input fields[3]
| Field | Type |
|---|---|
Task IDRequired | choice |
Delete a UserAction
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | choice |
Delete an OrderAction
Input fields[3]
| Field | Type |
|---|---|
Order IDRequired | choice |
Finish a TaskAction
Make an API Calluniversal
Mark a Deal as LostAction
Input fields[3]
| Field | Type |
|---|---|
Deal IDRequired | choice |
Mark a Deal as WonAction
Input fields[3]
| Field | Type |
|---|---|
Deal IDRequired | choice |
| Loss Reason ID | choice |
Reopen a DealAction
Input fields[3]
| Field | Type |
|---|---|
Deal IDRequired | choice |
| Loss Reason ID | choice |
Update a ContactAction
Input fields[3]
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Owner ID | choice |
| Name | text |
| Neighborhood | text |
| Note | text |
| CNPJ | text |
| Cnae code | text |
| Cnae name | text |
| Cnae secondary | text |
| Latitude | text |
| Longitude | text |
| Website | url |
| Avatar URL | url |
| Zip Code | number |
| Key | text |
| Register | text |
| City ID | choice |
| State ID | choice |
| Country ID | choice |
21other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Type ID | number |
| Name | text |
| Legal name | text |
| Register | text |
| CNPJ | text |
| CNPJ | text |
| Status ID | number |
| Company ID | text |
| Relationship ID | text |
| Line of business ID | text |
| Origin ID | text |
| Number of employees ID | text |
| Class ID | number |
| Owner ID | number |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Note | text |
| text |
50other output fields
Update a DealAction
Input fields[3]
| Field | Type |
|---|---|
Deal IDRequired | choice |
| Title | text |
| Contact ID | choice |
| Amount | number |
| Stage ID | choice |
| Other Properties | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Type ID | number |
| Name | text |
| Legal name | text |
| Register | text |
| CNPJ | text |
| CNPJ | text |
| Status ID | number |
| Company ID | text |
| Relationship ID | text |
| Line of business ID | text |
| Origin ID | text |
| Number of employees ID | text |
| Class ID | number |
| Owner ID | number |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Note | text |
| text |
50other output fields
Update a DocumentAction
Update a ProductAction
Input fields[3]
| Field | Type |
|---|---|
Product IDRequired | choice |
| Name | text |
| Group ID | choice |
| Family ID | choice |
| Product Code | text |
| Measurement Unit | text |
| Image URL | url |
| Currency ID | choice |
| Unit Price | number |
| Create Import ID | number |
| Update Import ID | number |
| Editable | boolean |
| Deletable | boolean |
| Suspended | boolean |
| Creator ID | choice |
| Updater ID | choice |
| Creation Date | date |
| Last Update Date | date |
| Importation ID on Create | number |
| Importation ID on Update | number |
1other input field
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Group ID | number |
| Family ID | text |
| Name | text |
| Code | text |
| Measurement unit | text |
| Image URL | url |
| Currency ID | text |
| Unit price | number |
| Create import ID | text |
| Update import ID | text |
| Editable | boolean |
| Deletable | boolean |
| Suspended | boolean |
| Creator ID | number |
| Updater ID | text |
| Create date | date |
| Last update date | date |
| Importation ID create | text |
| Importation ID update | text |
Update a QuoteAction
Input fields[3]
| Field | Type |
|---|---|
Quote IDRequired | choice |
| Deal | object |
| Title | text |
| Contact ID | choice |
| Template ID | choice |
| Sections | array |
| Currency ID | choice |
| Amount | number |
| Other Properties | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Contact ID | number |
| Account ID | number |
| Contact name | text |
| Deal ID | number |
| Owner ID | number |
| Template ID | number |
| Is template | boolean |
| Date | text |
| Quote number | number |
| Review number | number |
| Last review | boolean |
| Last review ID | number |
| Approver | boolean |
| Approval status ID | text |
| Approval level ID | text |
| Person ID | text |
| Person name | text |
| Currency ID | number |
| Amount | number |
40other output fields
Update a TaskAction
Update a UserAction
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | choice |
| Name | text |
| Profile ID | choice |
| Password | text |
| Other Properties | array |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Account ID | number |
| Name | text |
| text | |
| Phone | text |
| Avatar URL | url |
| Role ID | text |
| Profile ID | number |
| text | |
| Linked in | text |
| Birthday | text |
| Next anniversary | text |
| Previous anniversary | text |
| Integration | boolean |
| Native integration | boolean |
| Google authenticator configured | text |
| User key | text |
| Last login | text |
| Frequency | text |
| Account owner | boolean |
21other output fields
Templates
Look for Ploomes templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Breakcold CRM[2]Lightweight CRM for sales teams to manage leads, pipelines, and customer relationships.
- AffinityRelationship intelligence CRM for deal flow, people, and organizations.
- ClientifyCRM and sales automation platform for managing contacts, deals, and customer communication.
- Agile CRMManage contacts, companies, and deals in Agile CRM.
- ApptivoAll-in-one CRM and business suite for contacts, deals, projects, and invoicing.
References
- WEXTL® Ploomes Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Ploomes.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12