Vitally integration guide
VerifiedHow to connect Vitally to WEXTL and use its 10 triggers and 89 actions in your workflows. About Vitally: Customer success platform for tracking accounts, health, tasks and notes.
- 10 triggers
- 40 searches
- 49 actions
- Polling
- Auth: API key
AI-assisted documentation33 min read
This documentation is compiled from our integration source code, internal specs for Vitally, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Vitally credentials
Vitally - Analytics API Key
- Analytics API TokenpasswordRequired
In Vitally open Settings, then Integrations, then Vitally Analytics API and copy the token. Paste it exactly as Vitally shows it.[1]
- Data CenterselectRequired
Choose EU only if your address ends in vitally-eu.io.[1]
- Subdomaintext
US only. The first part of the address you sign in at, for example acme in acme.vitally.io. Leave blank for EU.[1]
Vitally - REST API Key
- REST API Secret TokenpasswordRequired
In Vitally open Settings, then Integrations, then Vitally REST API, switch it on and copy the secret token of a key. Paste the secret token, not the Basic Auth header.[1]
- Data CenterselectRequired
Choose EU only if your address ends in vitally-eu.io.[1]
- Subdomaintext
US only. The first part of the address you sign in at, for example acme in acme.vitally.io. Leave blank for EU.[1]
Connect Vitally in WEXTL
- Log in to your WEXTL account, add the Vitally node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Vitally 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 →
Vitally triggers and actions on WEXTL
The list below is a reference of every Vitally node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Vitally node module below to inspect its input parameters, outputs, and connection requirements.
Watch Accounts
TriggerFires on a schedule as accounts appear or change.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization ID | text |
| Account Owner ID | text |
| MRR | number |
| Next Renewal Date | date |
| Churned At | date |
| First Seen Timestamp | date |
14other output fields
Watch Conversations
TriggerFires on a schedule when conversations appear or change.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Subject | text |
| Messages | array |
| Message | object |
| Traits | object |
| Accounts | array |
| Account | object |
| Users | array |
| User | object |
| Admins | array |
| Admin | object |
| Status | text |
| Rating | text |
2other output fields
Watch Custom Object Instances
TriggerReports created or updated custom object instances on a schedule.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| External ID | text |
| Custom Object ID | text |
| Created By Vitally User ID | text |
| Owned By Vitally User ID | text |
| Customer ID | text |
| Customer | object |
| Customers | array |
| Customer | object |
| Organization ID | text |
6other output fields
Watch Meetings
TriggerPicks up created or updated meetings on a schedule.
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| Title | text |
| Description | text |
| Location | text |
| Start Date | date |
| Start Date Time | date |
| Start Time Zone | text |
| End Date | date |
| End Date Time | date |
| End Time Zone | text |
| External Status | text |
17other output fields
Watch Notes
TriggerReports new or changed notes at each scheduled check.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Note | text |
| Note Date | date |
| Subject | text |
| Author ID | text |
| Category ID | text |
| Archived At | date |
| Source | text |
| Tags | array |
| Item | text |
5other output fields
Watch NPS Responses
TriggerDelivers new or changed survey scores on a schedule.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| User ID | text |
| User | object |
| Score | number |
| Feedback | text |
| Responded At | date |
| Created By Service | text |
| Survey Response ID | text |
| Outbound Message ID | text |
Watch Organizations
TriggerFlags created or updated organizations on a schedule.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization Owner ID | text |
| MRR | number |
| First Paid Date | date |
| Next Renewal Date | date |
| Churned At | date |
| Trial End Date | date |
11other output fields
Watch Projects
TriggerTriggers for new or changed projects.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Name | text |
| Account ID | text |
| Organization ID | text |
| Template ID | text |
| Duration In Days | number |
| Target Start Date | date |
| Actual Start Date | date |
| Target Completion Date | date |
| Actual Completion Date | date |
| Owned By Vitally User ID | text |
4other output fields
Watch Tasks
TriggerEmits created or updated tasks at each check.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Organization ID | text |
| Account ID | text |
| Name | text |
| Description | text |
| Completed At | date |
| Due Date | date |
| Tags | array |
| Item | text |
| Archived At | date |
11other output fields
Watch Users
TriggerCatches created or updated users on each scheduled check.
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| text | |
| Avatar | text |
| Traits | object |
| First Known | date |
| Last Seen Timestamp | date |
| Last Inbound Message Timestamp | date |
| Last Outbound Message Timestamp | date |
10other output fields
Find a Custom Object Instance
SearchFirst instance of a custom object that matches one detail.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
Search ByRequired | choice |
| Integration Source | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| External ID | text |
| Custom Object ID | text |
| Created By Vitally User ID | text |
| Owned By Vitally User ID | text |
| Customer ID | text |
| Customer | object |
| Customers | array |
| Customer | object |
| Organization ID | text |
6other output fields
Find a Meeting
SearchLooks up meetings from calendar or recorder hints.
| Field | Type |
|---|---|
| Calendar Event ID | text |
| iCal UID | text |
| Recorder Call ID | text |
| Start | date |
| End | date |
| Title | text |
| Participant Emails | array |
| text | |
| Conference URL | text |
| Time Window (minutes) | number |
| Field | Type |
|---|---|
| Matches | array |
| Matche | object |
Find a User
SearchUsers matching an email, an ID or a domain.
| Field | Type |
|---|---|
Search ByRequired | choice |
| Field | Type |
|---|---|
| Results | array |
| Result | object |
Find an Admin
SearchTeam member match for an email address.
| Field | Type |
|---|---|
EmailRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| text | |
| License Status | text |
| Role | text |
Get a Conversation
SearchOne conversation, its messages and its status.
| Field | Type |
|---|---|
Conversation IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Subject | text |
| Messages | array |
| Message | object |
| Traits | object |
| Accounts | array |
| Account | object |
| Users | array |
| User | object |
| Admins | array |
| Admin | object |
| Status | text |
| Rating | text |
2other output fields
Get a Custom Object
SearchName, label and fields of a custom object.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| Label | text |
| Sync Active | boolean |
| Write Mode | text |
| Custom Fields | array |
| Custom Field | object |
Get a Meeting
SearchOne meeting with its time, location and recording link.
| Field | Type |
|---|---|
MeetingRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| Title | text |
| Description | text |
| Location | text |
| Start Date | date |
| Start Date Time | date |
| Start Time Zone | text |
| End Date | date |
| End Date Time | date |
| End Time Zone | text |
| External Status | text |
17other output fields
Get a Meeting Transcript
SearchThe full transcript text of a meeting.
| Field | Type |
|---|---|
MeetingRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Meeting ID | text |
| Created At | date |
| Updated At | date |
| Transcript | array |
| Transcript | object |
Get a Message
SearchA single message with its sender and recipients.
| Field | Type |
|---|---|
Message IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| External ID | text |
| Timestamp | date |
| Message | text |
| From | object |
| Type | text |
| ID | text |
| To | array |
| To | object |
| Cc | array |
| Cc | object |
| Bcc | array |
| Bcc | object |
Get a Note
SearchOne note with its subject, author and tags.
| Field | Type |
|---|---|
Note IDRequired | text |
| Integration Source | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Note | text |
| Note Date | date |
| Subject | text |
| Author ID | text |
| Category ID | text |
| Archived At | date |
| Source | text |
| Tags | array |
| Item | text |
5other output fields
Get a Project
SearchOne project with its owner and template.
| Field | Type |
|---|---|
ProjectRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Name | text |
| Account ID | text |
| Organization ID | text |
| Template ID | text |
| Duration In Days | number |
| Target Start Date | date |
| Actual Start Date | date |
| Target Completion Date | date |
| Actual Completion Date | date |
| Owned By Vitally User ID | text |
4other output fields
Get a Survey Question
SearchA survey question with its Title and Data.
| Field | Type |
|---|---|
Question IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
| Data | object |
| Type | text |
| Options | array |
Get a Survey Response
SearchA single survey submission and its answers.
| Field | Type |
|---|---|
Response IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Survey ID | text |
| Created At | date |
| Updated At | date |
| Responded At | date |
| User ID | text |
| Question Responses | array |
| Question Response | object |
Get a Task
SearchOne task with its due date, completion time and tags.
| Field | Type |
|---|---|
Task IDRequired | text |
| Integration Source | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Organization ID | text |
| Account ID | text |
| Name | text |
| Description | text |
| Completed At | date |
| Due Date | date |
| Tags | array |
| Item | text |
| Archived At | date |
11other output fields
Get a Transcript
SearchA transcript fetched by its own ID.
| Field | Type |
|---|---|
Transcript IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Meeting ID | text |
| Created At | date |
| Updated At | date |
| Transcript | array |
| Transcript | object |
Get a User
SearchOne user with contact details and last-seen times.
| Field | Type |
|---|---|
UserRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| text | |
| Avatar | text |
| Traits | object |
| First Known | date |
| Last Seen Timestamp | date |
| Last Inbound Message Timestamp | date |
| Last Outbound Message Timestamp | date |
10other output fields
Get Account Health Scores
SearchThe Health Scores Vitally holds for one account.
| Field | Type |
|---|---|
AccountRequired | choice |
| Field | Type |
|---|---|
| Health Scores | text |
Get an Account
SearchA single account with owner and renewal date.
| Field | Type |
|---|---|
AccountRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization ID | text |
| Account Owner ID | text |
| MRR | number |
| Next Renewal Date | date |
| Churned At | date |
| First Seen Timestamp | date |
14other output fields
Get an Admin
SearchOne team member from Vitally.
| Field | Type |
|---|---|
Team MemberRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| text | |
| License Status | text |
| Role | text |
Get an NPS Response
SearchOne survey score with its feedback and time.
| Field | Type |
|---|---|
NPS Response IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| User ID | text |
| User | object |
| Score | number |
| Feedback | text |
| Responded At | date |
| Created By Service | text |
| Survey Response ID | text |
| Outbound Message ID | text |
Get an Organization
SearchOne organization with renewal and trial dates.
| Field | Type |
|---|---|
OrganizationRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization Owner ID | text |
| MRR | number |
| First Paid Date | date |
| Next Renewal Date | date |
| Churned At | date |
| Trial End Date | date |
11other output fields
List Accounts
SearchAccounts across the workspace or inside one organization.
| Field | Type |
|---|---|
ScopeRequired | choice |
LimitRequired | number |
| Status | choice |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization ID | text |
| Account Owner ID | text |
| MRR | number |
| Next Renewal Date | date |
| Churned At | date |
| First Seen Timestamp | date |
14other output fields
List Admins
SearchTeam members with their roles and license status.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| text | |
| License Status | text |
| Role | text |
List Conversations
SearchConversations with subject, status and rating.
| Field | Type |
|---|---|
ScopeRequired | choice |
LimitRequired | number |
| Integration Source | text |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Subject | text |
| Messages | array |
| Message | object |
| Traits | object |
| Accounts | array |
| Account | object |
| Users | array |
| User | object |
| Admins | array |
| Admin | object |
| Status | text |
| Rating | text |
2other output fields
List Custom Object Instances
SearchEntries of a custom object, limited to an account or organization if needed.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
ScopeRequired | choice |
LimitRequired | number |
| Show Deleted Only | boolean |
| Integration Source | text |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| External ID | text |
| Custom Object ID | text |
| Created By Vitally User ID | text |
| Owned By Vitally User ID | text |
| Customer ID | text |
| Customer | object |
| Customers | array |
| Customer | object |
| Organization ID | text |
6other output fields
List Custom Objects
SearchCustom object types with label and write mode.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| Label | text |
| Sync Active | boolean |
| Write Mode | text |
| Custom Fields | array |
| Custom Field | object |
List Custom Traits
SearchTrait names, types and paths for one kind of record.
| Field | Type |
|---|---|
Record TypeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Label | text |
| Path | text |
| Type | text |
| Options | array |
| Option | object |
List Meeting Transcripts
SearchTranscripts together with their meeting IDs.
| Field | Type |
|---|---|
LimitRequired | number |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Meeting ID | text |
| Created At | date |
| Updated At | date |
| Transcript | array |
| Transcript | object |
List Meetings
SearchMeetings with their times, location and recording links.
| Field | Type |
|---|---|
ScopeRequired | choice |
LimitRequired | number |
| Show Archived Only | boolean |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| Title | text |
| Description | text |
| Location | text |
| Start Date | date |
| Start Date Time | date |
| Start Time Zone | text |
| End Date | date |
| End Date Time | date |
| End Time Zone | text |
| External Status | text |
17other output fields
List Note Categories
SearchNote category names available in Vitally.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
List Notes
SearchNotes with subject, author, category and tags.
| Field | Type |
|---|---|
ScopeRequired | choice |
LimitRequired | number |
| Show Deleted Only | boolean |
| Integration Source | text |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Note | text |
| Note Date | date |
| Subject | text |
| Author ID | text |
| Category ID | text |
| Archived At | date |
| Source | text |
| Tags | array |
| Item | text |
5other output fields
List NPS Responses
SearchSurvey scores and comments from users.
| Field | Type |
|---|---|
ScopeRequired | choice |
LimitRequired | number |
| Group By | choice |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| User ID | text |
| User | object |
| Score | number |
| Feedback | text |
| Responded At | date |
| Created By Service | text |
| Survey Response ID | text |
| Outbound Message ID | text |
List Organizations
SearchOrganizations with MRR and renewal dates.
| Field | Type |
|---|---|
LimitRequired | number |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization Owner ID | text |
| MRR | number |
| First Paid Date | date |
| Next Renewal Date | date |
| Churned At | date |
| Trial End Date | date |
11other output fields
List Project Categories
SearchProject category names with their creation timestamps.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
List Project Templates
SearchTemplates with their project name and description.
| Field | Type |
|---|---|
LimitRequired | number |
| Project Category | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| Project Name | text |
| Description | text |
| Project Category ID | text |
| Traits | object |
List Projects
SearchProjects with target dates and status IDs.
| Field | Type |
|---|---|
ScopeRequired | choice |
LimitRequired | number |
| Show Deleted Only | boolean |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Name | text |
| Account ID | text |
| Organization ID | text |
| Template ID | text |
| Duration In Days | number |
| Target Start Date | date |
| Actual Start Date | date |
| Target Completion Date | date |
| Actual Completion Date | date |
| Owned By Vitally User ID | text |
4other output fields
List Survey Responses
SearchAnswers submitted for one survey.
| Field | Type |
|---|---|
Survey IDRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Survey ID | text |
| Created At | date |
| Updated At | date |
| Responded At | date |
| User ID | text |
| Question Responses | array |
| Question Response | object |
List Task Categories
SearchTask category names and when they were created.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
List Tasks
SearchTasks with due dates, tags and completion times.
| Field | Type |
|---|---|
ScopeRequired | choice |
LimitRequired | number |
| Show Deleted Only | boolean |
| Integration Source | text |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Organization ID | text |
| Account ID | text |
| Name | text |
| Description | text |
| Completed At | date |
| Due Date | date |
| Tags | array |
| Item | text |
| Archived At | date |
11other output fields
List Users
SearchUsers with email, traits and last-seen times.
| Field | Type |
|---|---|
ScopeRequired | choice |
LimitRequired | number |
| Sort By | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| text | |
| Avatar | text |
| Traits | object |
| First Known | date |
| Last Seen Timestamp | date |
| Last Inbound Message Timestamp | date |
| Last Outbound Message Timestamp | date |
10other output fields
Add a Meeting Participant
ActionBrings one more person into an existing meeting.
| Field | Type |
|---|---|
MeetingRequired | choice |
Participant IsRequired | choice |
RoleRequired | choice |
| Response | choice |
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| Title | text |
| Description | text |
| Location | text |
| Start Date | date |
| Start Date Time | date |
| Start Time Zone | text |
| End Date | date |
| End Date Time | date |
| End Time Zone | text |
| External Status | text |
17other output fields
Add a Task to a Project
ActionPlaces a task in a project, optionally in a particular milestone.
| Field | Type |
|---|---|
ProjectRequired | choice |
Task IDRequired | text |
| Milestone | text |
| Integration Source | text |
| Field | Type |
|---|---|
| Created | boolean |
Add an Account to a Custom Object Instance
ActionPuts an account on a custom object entry, with a segment ID if needed.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
InstanceRequired | choice |
AccountRequired | choice |
| Integration Source | text |
| Field | Type |
|---|---|
| Created | boolean |
Add an Organization to a Custom Object Instance
ActionGives a custom object record an organization link.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
InstanceRequired | choice |
OrganizationRequired | choice |
| Integration Source | text |
| Field | Type |
|---|---|
| Created | boolean |
Create a Conversation
ActionLogs a conversation, with an optional first message.
| Field | Type |
|---|---|
SubjectRequired | text |
| External ID | text |
| First Message | text |
| Sent By | choice |
| First Message External ID | text |
| Recipients | array |
| Recipient | object |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Subject | text |
| Messages | array |
| Message | object |
| Traits | object |
| Accounts | array |
| Account | object |
| Users | array |
| User | object |
| Admins | array |
| Admin | object |
| Status | text |
| Rating | text |
3other output fields
Create a Custom Object
ActionNew custom object type with its fields.
| Field | Type |
|---|---|
NameRequired | text |
LabelRequired | text |
Who Can Create InstancesRequired | choice |
| Custom Fields | array |
| Custom Field | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| Label | text |
| Sync Active | boolean |
| Write Mode | text |
| Custom Fields | array |
| Custom Field | object |
Create a Custom Object Instance
ActionNew record of a custom object, linked to accounts or organizations.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
NameRequired | text |
| Account | choice |
| Organization | choice |
| External ID | text |
| Owner | choice |
| Created By | choice |
| Created At | date |
| Description | text |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| External ID | text |
| Custom Object ID | text |
| Created By Vitally User ID | text |
| Owned By Vitally User ID | text |
| Customer ID | text |
| Customer | object |
| Customers | array |
| Customer | object |
| Organization ID | text |
6other output fields
Create a Meeting
ActionLogs a meeting and its participants in Vitally.
| Field | Type |
|---|---|
External IDRequired | text |
TitleRequired | text |
ParticipantsRequired | array |
| Participant | object |
| Description | text |
| Location | text |
| Start | date |
| End | date |
| Recording URL | text |
| Summary | text |
| Key Points | array |
| Key Point | text |
| Risk Assessment | text |
| Integration Source | text |
1other input field
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| Title | text |
| Description | text |
| Location | text |
| Start Date | date |
| Start Date Time | date |
| Start Time Zone | text |
| End Date | date |
| End Date Time | date |
| End Time Zone | text |
| External Status | text |
17other output fields
Create a Message
ActionPuts a message on an existing conversation thread.
| Field | Type |
|---|---|
Conversation IDRequired | text |
MessageRequired | text |
Sent ByRequired | choice |
| Recipients | array |
| Recipient | object |
| External ID | text |
| Sent At | date |
| CC | array |
| CC Recipient | object |
| BCC | array |
| BCC Recipient | object |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| External ID | text |
| Timestamp | date |
| Message | text |
| From | object |
| Type | text |
| ID | text |
| To | array |
| To | object |
| Cc | array |
| Cc | object |
| Bcc | array |
| Bcc | object |
Create a Note
ActionSaves a note on an account or an organization.
| Field | Type |
|---|---|
Applies ToRequired | choice |
NoteRequired | text |
| Note Date | date |
| Subject | text |
| Author | choice |
| Category | choice |
| Tags | array |
| Tag | text |
| External ID | text |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Note | text |
| Note Date | date |
| Subject | text |
| Author ID | text |
| Category ID | text |
| Archived At | date |
| Source | text |
| Tags | array |
| Item | text |
5other output fields
Create a Project
ActionNew project built from a chosen template.
| Field | Type |
|---|---|
Project TemplateRequired | choice |
Applies ToRequired | choice |
| Name | text |
| Target Start Date | date |
| Target Completion Date | date |
| Project Status ID | text |
| Project Category | choice |
| Owner | choice |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Name | text |
| Account ID | text |
| Organization ID | text |
| Template ID | text |
| Duration In Days | number |
| Target Start Date | date |
| Actual Start Date | date |
| Target Completion Date | date |
| Actual Completion Date | date |
| Owned By Vitally User ID | text |
4other output fields
Create a Task
ActionCreates a task with due date, assignee and tags.
| Field | Type |
|---|---|
NameRequired | text |
Applies ToRequired | choice |
| Description | text |
| Assigned To | choice |
| Due Date | date |
| Completed At | date |
| Completed By | choice |
| Category | choice |
| Tags | array |
| Tag | text |
| External ID | text |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Organization ID | text |
| Account ID | text |
| Name | text |
| Description | text |
| Completed At | date |
| Due Date | date |
| Tags | array |
| Item | text |
| Archived At | date |
11other output fields
Create a User
ActionNew user linked to accounts or organizations.
| Field | Type |
|---|---|
External IDRequired | text |
| Accounts | choice |
| Organizations | choice |
| Name | text |
| text | |
| Avatar URL | text |
| Join Date | date |
| Unsubscribed from Conversations | boolean |
| Permanently Bounced | boolean |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| text | |
| Avatar | text |
| Traits | object |
| First Known | date |
| Last Seen Timestamp | date |
| Last Inbound Message Timestamp | date |
| Last Outbound Message Timestamp | date |
10other output fields
Create an Account
ActionNew account with its own ID, name and traits.
| Field | Type |
|---|---|
External IDRequired | text |
NameRequired | text |
| Organization | choice |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization ID | text |
| Account Owner ID | text |
| MRR | number |
| Next Renewal Date | date |
| Churned At | date |
| First Seen Timestamp | date |
14other output fields
Create an NPS Response
ActionLogs a survey score from a user.
| Field | Type |
|---|---|
User IDRequired | text |
ScoreRequired | number |
Responded AtRequired | date |
| Feedback | text |
| External ID | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| User ID | text |
| User | object |
| Score | number |
| Feedback | text |
| Responded At | date |
| Created By Service | text |
| Survey Response ID | text |
| Outbound Message ID | text |
Create an Organization
ActionNew organization with its own ID and trait values.
| Field | Type |
|---|---|
External IDRequired | text |
NameRequired | text |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization Owner ID | text |
| MRR | number |
| First Paid Date | date |
| Next Renewal Date | date |
| Churned At | date |
| Trial End Date | date |
11other output fields
Delete a Conversation
ActionRemoves a conversation, final and irreversible.
| Field | Type |
|---|---|
Conversation IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Custom Object Instance
ActionDeletes one stored record of a custom object type.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
InstanceRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Meeting
ActionArchives a meeting in Vitally.
| Field | Type |
|---|---|
MeetingRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Message
ActionRemoves one message from a thread.
| Field | Type |
|---|---|
Message IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Note
ActionRemoves one note from an account or organization.
| Field | Type |
|---|---|
Note IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Project
ActionRemoves a single project from the workspace.
| Field | Type |
|---|---|
ProjectRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Task
ActionRemoves a task from Vitally.
| Field | Type |
|---|---|
Task IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a User
ActionRemoves a user now or on a chosen date.
| Field | Type |
|---|---|
User IDRequired | text |
| Delete On | date |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete an Account
ActionFinal removal of one account.
| Field | Type |
|---|---|
AccountRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete an NPS Response
ActionRemoves one survey score.
| Field | Type |
|---|---|
NPS Response IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete an Organization
ActionFinal removal of an organization.
| Field | Type |
|---|---|
OrganizationRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Make an Analytics API Call
universalYour own Vitally Analytics REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Make an API Call
universalYour own Vitally REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Move a Project
ActionChanges who a project belongs to.
| Field | Type |
|---|---|
Currently Belongs ToRequired | choice |
ProjectRequired | choice |
Move ToRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Name | text |
| Account ID | text |
| Organization ID | text |
| Template ID | text |
| Duration In Days | number |
| Target Start Date | date |
| Actual Start Date | date |
| Target Completion Date | date |
| Actual Completion Date | date |
| Owned By Vitally User ID | text |
4other output fields
Remove a Meeting Participant
ActionRemoves an attendee or organizer from a meeting.
| Field | Type |
|---|---|
MeetingRequired | choice |
ParticipantRequired | choice |
| Field | Type |
|---|---|
| Meeting ID | text |
| Participant ID | text |
| Deleted | boolean |
Remove a Task from a Project
ActionBreaks the project link of a task.
| Field | Type |
|---|---|
ProjectRequired | choice |
Task IDRequired | text |
| Integration Source | text |
| Field | Type |
|---|---|
| Project ID | text |
| Task ID | text |
| Deleted | boolean |
Remove a User from an Account
ActionBreaks the tie between a user and an account via your own IDs.
| Field | Type |
|---|---|
User IDRequired | text |
Account IDRequired | text |
| Sent At | date |
| Message ID | text |
| Field | Type |
|---|---|
| Message | text |
| Message ID | text |
| Timestamp | date |
Remove an Account from a Custom Object Instance
ActionBreaks the link between one account and an entry.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
InstanceRequired | choice |
AccountRequired | choice |
| Integration Source | text |
| Field | Type |
|---|---|
| Instance ID | text |
| Account ID | text |
| Deleted | boolean |
Remove an Organization from a Custom Object Instance
ActionEnds the tie between an organization and an entry.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
InstanceRequired | choice |
OrganizationRequired | choice |
| Integration Source | text |
| Field | Type |
|---|---|
| Instance ID | text |
| Organization ID | text |
| Deleted | boolean |
Send an Event
ActionSends an event for a user, account or organization.
| Field | Type |
|---|---|
Event NameRequired | text |
Event Belongs ToRequired | choice |
| Properties | array |
| Property | object |
| Sent At | date |
| Message ID | text |
| Field | Type |
|---|---|
| Message | text |
| Message ID | text |
| Timestamp | date |
Update a Conversation
ActionRetitles a conversation or edits trait values.
| Field | Type |
|---|---|
Conversation IDRequired | text |
| Subject | text |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Subject | text |
| Messages | array |
| Message | object |
| Traits | object |
| Accounts | array |
| Account | object |
| Users | array |
| User | object |
| Admins | array |
| Admin | object |
| Status | text |
| Rating | text |
2other output fields
Update a Custom Object
ActionRenames or extends a custom object type.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
| Name | text |
| Label | text |
| Who Can Create Instances | choice |
| Add Custom Fields | array |
| Custom Field | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| Label | text |
| Sync Active | boolean |
| Write Mode | text |
| Custom Fields | array |
| Custom Field | object |
Update a Custom Object Instance
ActionEdits details and traits of one custom object entry.
| Field | Type |
|---|---|
Custom ObjectRequired | choice |
InstanceRequired | choice |
| Name | text |
| External ID | text |
| Owner | choice |
| Description | text |
| Traits | array |
| Trait | object |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Name | text |
| External ID | text |
| Custom Object ID | text |
| Created By Vitally User ID | text |
| Owned By Vitally User ID | text |
| Customer ID | text |
| Customer | object |
| Customers | array |
| Customer | object |
| Organization ID | text |
6other output fields
Update a Meeting
ActionEdits meeting details and traits.
| Field | Type |
|---|---|
MeetingRequired | choice |
| Title | text |
| Description | text |
| Location | text |
| Start | date |
| End | date |
| Recording URL | text |
| Summary | text |
| Key Points | array |
| Key Point | text |
| Risk Assessment | text |
| Traits | array |
| Trait | object |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| Title | text |
| Description | text |
| Location | text |
| Start Date | date |
| Start Date Time | date |
| Start Time Zone | text |
| End Date | date |
| End Date Time | date |
| End Time Zone | text |
| External Status | text |
17other output fields
Update a Note
ActionEdits one note and its tags.
| Field | Type |
|---|---|
Note IDRequired | text |
| Note | text |
| Note Date | date |
| Subject | text |
| Author | choice |
| Category | choice |
| External ID | text |
| Applies To | choice |
| Tags | array |
| Tag | text |
| Traits | array |
| Trait | object |
| Clear Fields | choice |
| Integration Source | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Note | text |
| Note Date | date |
| Subject | text |
| Author ID | text |
| Category ID | text |
| Archived At | date |
| Source | text |
| Tags | array |
| Item | text |
5other output fields
Update a Project
ActionEdits project dates, name and traits.
| Field | Type |
|---|---|
ProjectRequired | choice |
| Name | text |
| Target Start Date | date |
| Target Completion Date | date |
| Project Status ID | text |
| Project Category | choice |
| Owner | choice |
| Traits | array |
| Trait | object |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Name | text |
| Account ID | text |
| Organization ID | text |
| Template ID | text |
| Duration In Days | number |
| Target Start Date | date |
| Actual Start Date | date |
| Target Completion Date | date |
| Actual Completion Date | date |
| Owned By Vitally User ID | text |
4other output fields
Update a Task
ActionEdits one task, optionally moving it to another account or organization.
| Field | Type |
|---|---|
Task IDRequired | text |
| Name | text |
| Applies To | choice |
| Description | text |
| Assigned To | choice |
| Due Date | date |
| Completed At | date |
| Completed By | choice |
| Category | choice |
| Tags | array |
| Tag | text |
| External ID | text |
| Traits | array |
| Trait | object |
2other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Organization ID | text |
| Account ID | text |
| Name | text |
| Description | text |
| Completed At | date |
| Due Date | date |
| Tags | array |
| Item | text |
| Archived At | date |
11other output fields
Update a User
ActionEdits a user and adds more account or organization links.
| Field | Type |
|---|---|
User IDRequired | text |
| Add to Accounts | choice |
| Add to Organizations | choice |
| Name | text |
| text | |
| Avatar URL | text |
| Join Date | date |
| Unsubscribed from Conversations | choice |
| Permanently Bounced | choice |
| Traits | array |
| Trait | object |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| text | |
| Avatar | text |
| Traits | object |
| First Known | date |
| Last Seen Timestamp | date |
| Last Inbound Message Timestamp | date |
| Last Outbound Message Timestamp | date |
10other output fields
Update an Account
ActionEdits name, organization or traits of one account.
| Field | Type |
|---|---|
AccountRequired | choice |
| Name | text |
| Organization | choice |
| Traits | array |
| Trait | object |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization ID | text |
| Account Owner ID | text |
| MRR | number |
| Next Renewal Date | date |
| Churned At | date |
| First Seen Timestamp | date |
14other output fields
Update an NPS Response
ActionEdits one survey score or its answer time.
| Field | Type |
|---|---|
NPS Response IDRequired | text |
| User ID | text |
| Score | number |
| Responded At | date |
| Feedback | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| User ID | text |
| User | object |
| Score | number |
| Feedback | text |
| Responded At | date |
| Created By Service | text |
| Survey Response ID | text |
| Outbound Message ID | text |
Update an Organization
ActionChanges name and trait values on one organization.
| Field | Type |
|---|---|
OrganizationRequired | choice |
| Name | text |
| Traits | array |
| Trait | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| External ID | text |
| Name | text |
| Traits | object |
| Organization Owner ID | text |
| MRR | number |
| First Paid Date | date |
| Next Renewal Date | date |
| Churned At | date |
| Trial End Date | date |
11other output fields
Upload a Meeting Transcript
ActionSpeaker-by-speaker transcript for a meeting.
| Field | Type |
|---|---|
MeetingRequired | choice |
TranscriptRequired | array |
| Speaker Turn | object |
| Field | Type |
|---|---|
| ID | text |
| Meeting ID | text |
| Created At | date |
| Updated At | date |
| Transcript | array |
| Transcript | object |
Upload a Transcript to a Matching Meeting
ActionMatches a meeting from calendar hints and attaches a transcript.
| Field | Type |
|---|---|
TranscriptRequired | array |
| Speaker Turn | object |
| Meeting | choice |
| Start | date |
| End | date |
| Create If Not Found | boolean |
| Calendar Event ID | text |
| iCal UID | text |
| Recorder Call ID | text |
| Title | text |
| Participant Emails | array |
| text | |
| Conference URL | text |
| Time Window (minutes) | number |
| Field | Type |
|---|---|
| Meeting | object |
| Transcript | object |
| Meeting Created | boolean |
| Transcript Created | boolean |
| Confidence | text |
| Match Reasons | array |
| Item | text |
Templates
Look for Vitally templates in the WEXTL template library.
Browse templates →Other CRM integrations on WEXTL
Agiled[2]Manage CRM contacts, projects, tasks, invoices, tickets and time tracking in Agiled, the all-in-one business management platform.
ClientifyCRM and sales automation platform for managing contacts, deals, and customer communication.
EndearRetail clienteling CRM for managing customer profiles, messaging, tasks, and appointment booking.
Freshworks CRMSales CRM for contacts, accounts, deals, tasks and appointments. Search records, update the pipeline and watch new contacts and deals.
ApolloManage Apollo contacts, accounts, sequences, tasks and deals. Search saved records, enroll prospects and send outreach email.
References
- WEXTL® Vitally Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Vitally.
- WEXTL® visual workflow builder data.
Last updated: Nov 12, 2026 04:51
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.






























