Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Vome (Preview)
Vome is a volunteer management platform that helps organizations simplify scheduling, communication, and onboarding. This connector enables seamless integration between Vome and other services by allowing users to automate workflows such as sending confirmation emails when a volunteer signs up for a shift, updating CRM systems, and triggering onboarding steps based on user actions. By using this connector, organizations can reduce manual tasks and create a more engaging volunteer experience
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Vome |
| URL | https://support.vomevolunteer.com/portal/en/kb/articles/how-does-vome-support-work |
| support@vomevolunteer.com |
| Connector Metadata | |
|---|---|
| Publisher | Vome Volunteer |
| Website | https://www.vomevolunteer.com/ |
| Privacy policy | https://www.vomevolunteer.com/privacy |
| Categories | Productivity; IT Operations |
AutoReview
Creates automatic code review for your Power Automate flows. A Review document scores your flow to configurable metrics. A Report returns the flow information and a Diagram file creates a visual representation of the flow.
Publisher
Power DevBox
Prerequisites
A Power Automate license and a compliant DLP policy (Access to Power Automate Management Connectors or Dataverse Connectors)
Supported Operations
Info
Returns latest information on the connector, including version and key links. Find more information on the connector here.
JSON
Returns the AutoReview review in a json format
File
Returns a file of either the flow Review, Report, or Diagram
Obtaining Credentials
A API key is required, available to request here
Getting Started
Use either 'Get Flow' action or Dataverse 'Get Row by ID' action to return a flows definition/clientData values. Pass these values and other metadata into the AutoReview Connector.
Known Issues and Limitations
The Dataverse connector requires the definition input to be the clientData inside a json expression json(outputs('Get_a_row_by_ID')?['body/clientdata'])
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| api_key | securestring | The api_key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Triggers
| Archived Profile |
Triggers when a profile is archived in your database |
| Deleted Form Submission |
Triggers when a form submission is deleted |
| Deleted Profile |
Triggers when a profile is deleted from your Vome database |
| Deleted Reservation |
Triggers when a reservation is deleted |
| Deleted Sequence Assigment |
Triggers when a user's assignment to a sequence is deleted |
| New Form Submission |
Triggers when a user submits a Vome form |
| New Profile |
Triggers when new user is created |
| New Reservation |
Triggers when a new reservation is scheduled |
| New Sequence Assigned |
Triggers when a user is assigned to a sequence |
| Updated Form Submission |
Triggers when a user's form submission is updated |
| Updated Reservation |
Triggers when a user's reservation is updated |
| Updated Sequence |
Triggers when a user's assigned sequence is updated |
| UpdatedProfile |
Triggers when a profile is updated in your Vome database |
Archived Profile
- Operation ID:
- ArchivedProfile
Triggers when a profile is archived in your database
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
logged_hours
|
logged_hours | integer |
logged_hours |
|
is_offline
|
is_offline | boolean |
is_offline |
|
is_following
|
is_following | boolean |
is_following |
|
name
|
emergency_contact.name | string |
name |
|
phone_number
|
emergency_contact.phone_number | string |
phone_number |
|
relationship
|
emergency_contact.relationship | string |
relationship |
|
description
|
medical_information.description | string |
description |
|
has_medical_info
|
medical_information.has_medical_info | boolean |
has_medical_info |
|
first_name
|
profile_details.first_name | string |
first_name |
|
last_name
|
profile_details.last_name | string |
last_name |
|
full_name
|
profile_details.full_name | string |
full_name |
|
email
|
profile_details.email | string |
|
|
profile_image
|
profile_details.profile_image | string |
profile_image |
|
phone_number
|
profile_details.phone_number | string |
phone_number |
|
date_of_birth
|
profile_details.date_of_birth | string |
date_of_birth |
|
gender
|
profile_details.gender | string |
gender |
|
gender_text
|
profile_details.gender_text | string |
gender_text |
|
occupation
|
profile_details.occupation | string |
occupation |
|
occupation_institution_name
|
profile_details.occupation_institution_name | string |
occupation_institution_name |
|
skills
|
profile_details.skills | array of |
skills |
|
languages
|
profile_details.languages | array of |
languages |
|
address
|
profile_details.address | string |
address |
|
created_at
|
profile_details.created_at | string |
created_at |
|
age
|
profile_details.age | string |
age |
|
address_coordinates
|
profile_details.address_coordinates | array of |
address_coordinates |
|
opportunities
|
opportunities | array of object |
opportunities |
|
id
|
opportunities.id | string |
id |
|
id
|
opportunities.opportunity.id | string |
id |
|
title
|
opportunities.opportunity.title | string |
title |
|
id
|
opportunities.opportunity.category.id | string |
id |
|
title
|
opportunities.opportunity.category.title | string |
title |
|
most_recent_shift
|
most_recent_shift | string |
most_recent_shift |
|
completed_shifts
|
completed_shifts | integer |
completed_shifts |
|
profile_tags
|
profile_tags | array of object |
profile_tags |
|
id
|
profile_tags.id | string |
id |
|
id
|
profile_tags.tag.id | string |
id |
|
tag_title
|
profile_tags.tag.tag_title | string |
tag_title |
|
custom_fields
|
custom_fields | array of object |
custom_fields |
|
id
|
custom_fields.id | string |
id |
|
id
|
custom_fields.custom_field.id | string |
id |
|
field_type
|
custom_fields.custom_field.field_type | integer |
field_type |
|
is_active
|
custom_fields.custom_field.is_active | boolean |
is_active |
|
options
|
custom_fields.custom_field.options | array of object |
options |
|
id
|
custom_fields.custom_field.options.id | string |
id |
|
value
|
custom_fields.custom_field.options.value | string |
value |
|
order
|
custom_fields.custom_field.options.order | integer |
order |
|
custom_field_value
|
custom_fields.custom_field_value | array of object |
custom_field_value |
|
id
|
custom_fields.custom_field_value.id | string |
id |
|
id
|
custom_fields.custom_field_value.value.id | string |
id |
|
value
|
custom_fields.custom_field_value.value.value | string |
value |
|
order
|
custom_fields.custom_field_value.value.order | integer |
order |
Deleted Form Submission
- Operation ID:
- DeletedFormSubmission
Triggers when a form submission is deleted
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
user.id | string |
id |
|
first_name
|
user.first_name | string |
first_name |
|
last_name
|
user.last_name | string |
last_name |
|
email
|
user.email | string |
|
|
gender
|
user.gender | string |
gender |
|
address
|
user.address | string |
address |
|
phone_number
|
user.phone_number | string |
phone_number |
|
date_of_birth
|
user.date_of_birth | string |
date_of_birth |
|
timezone
|
user.timezone | string |
timezone |
|
address_coordinates
|
user.address_coordinates | string |
address_coordinates |
|
submission_status
|
submission_status | string |
submission_status |
|
created_at
|
created_at | string |
created_at |
|
arrival_source
|
arrival_source | string |
arrival_source |
|
questions
|
questions | array of object |
questions |
|
id
|
questions.id | string |
id |
|
id
|
questions.question.id | string |
id |
|
title
|
questions.question.title | string |
title |
|
question_type
|
questions.question.question_type | string |
question_type |
|
options
|
questions.question.options | array of string |
options |
|
answer
|
questions.answer | string |
answer |
|
options
|
questions.options | array of string |
options |
|
responded
|
questions.responded | boolean |
responded |
|
medical_info
|
medical_info | string |
medical_info |
|
id
|
emergency_contact.id | string |
id |
|
name
|
emergency_contact.name | string |
name |
|
relationship
|
emergency_contact.relationship | string |
relationship |
|
phone_number
|
emergency_contact.phone_number | string |
phone_number |
|
digital_consent
|
digital_consent | array of object |
digital_consent |
|
id
|
digital_consent.id | string |
id |
|
digital_consent_info
|
digital_consent.digital_consent_info | string |
digital_consent_info |
|
attached_file
|
digital_consent.attached_file | string |
attached_file |
|
consent_status
|
digital_consent.consent_status | integer |
consent_status |
|
general_availability
|
general_availability | array of object |
general_availability |
|
id
|
general_availability.id | string |
id |
|
day
|
general_availability.day | integer |
day |
|
availability
|
general_availability.availability | string |
availability |
|
attachments
|
attachments | array of object |
attachments |
|
id
|
attachments.id | string |
id |
|
document_file
|
attachments.document_file | string |
document_file |
|
notes
|
attachments.notes | string |
notes |
|
id
|
attachments.attachment_info.id | string |
id |
|
title
|
attachments.attachment_info.title | string |
title |
|
description
|
attachments.attachment_info.description | string |
description |
|
opportunities
|
opportunities | array of |
opportunities |
|
name
|
folder.name | string |
name |
|
id
|
form.id | string |
id |
|
title
|
form.title | string |
title |
Deleted Profile
- Operation ID:
- DeletedProfile
Triggers when a profile is deleted from your Vome database
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
logged_hours
|
logged_hours | integer |
logged_hours |
|
is_offline
|
is_offline | boolean |
is_offline |
|
is_following
|
is_following | boolean |
is_following |
|
name
|
emergency_contact.name | string |
name |
|
phone_number
|
emergency_contact.phone_number | string |
phone_number |
|
relationship
|
emergency_contact.relationship | string |
relationship |
|
description
|
medical_information.description | string |
description |
|
has_medical_info
|
medical_information.has_medical_info | boolean |
has_medical_info |
|
first_name
|
profile_details.first_name | string |
first_name |
|
last_name
|
profile_details.last_name | string |
last_name |
|
full_name
|
profile_details.full_name | string |
full_name |
|
email
|
profile_details.email | string |
|
|
profile_image
|
profile_details.profile_image | string |
profile_image |
|
phone_number
|
profile_details.phone_number | string |
phone_number |
|
date_of_birth
|
profile_details.date_of_birth | string |
date_of_birth |
|
gender
|
profile_details.gender | string |
gender |
|
gender_text
|
profile_details.gender_text | string |
gender_text |
|
occupation
|
profile_details.occupation | string |
occupation |
|
occupation_institution_name
|
profile_details.occupation_institution_name | string |
occupation_institution_name |
|
skills
|
profile_details.skills | array of |
skills |
|
languages
|
profile_details.languages | array of |
languages |
|
address
|
profile_details.address | string |
address |
|
created_at
|
profile_details.created_at | string |
created_at |
|
age
|
profile_details.age | string |
age |
|
address_coordinates
|
profile_details.address_coordinates | array of |
address_coordinates |
|
opportunities
|
opportunities | array of object |
opportunities |
|
id
|
opportunities.id | string |
id |
|
id
|
opportunities.opportunity.id | string |
id |
|
title
|
opportunities.opportunity.title | string |
title |
|
id
|
opportunities.opportunity.category.id | string |
id |
|
title
|
opportunities.opportunity.category.title | string |
title |
|
most_recent_shift
|
most_recent_shift | string |
most_recent_shift |
|
completed_shifts
|
completed_shifts | integer |
completed_shifts |
|
profile_tags
|
profile_tags | array of object |
profile_tags |
|
id
|
profile_tags.id | string |
id |
|
id
|
profile_tags.tag.id | string |
id |
|
tag_title
|
profile_tags.tag.tag_title | string |
tag_title |
|
custom_fields
|
custom_fields | array of object |
custom_fields |
|
id
|
custom_fields.id | string |
id |
|
id
|
custom_fields.custom_field.id | string |
id |
|
field_type
|
custom_fields.custom_field.field_type | integer |
field_type |
|
is_active
|
custom_fields.custom_field.is_active | boolean |
is_active |
|
options
|
custom_fields.custom_field.options | array of object |
options |
|
id
|
custom_fields.custom_field.options.id | string |
id |
|
value
|
custom_fields.custom_field.options.value | string |
value |
|
order
|
custom_fields.custom_field.options.order | integer |
order |
|
custom_field_value
|
custom_fields.custom_field_value | array of object |
custom_field_value |
|
id
|
custom_fields.custom_field_value.id | string |
id |
|
id
|
custom_fields.custom_field_value.value.id | string |
id |
|
value
|
custom_fields.custom_field_value.value.value | string |
value |
|
order
|
custom_fields.custom_field_value.value.order | integer |
order |
Deleted Reservation
- Operation ID:
- DeletedReservation
Triggers when a reservation is deleted
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
shift.id | string |
id |
|
created_at
|
shift.created_at | string |
created_at |
|
shift_start_at
|
shift.shift_start_at | string |
shift_start_at |
|
shift_end_at
|
shift.shift_end_at | string |
shift_end_at |
|
spots
|
shift.spots | integer |
spots |
|
shift_title
|
shift.shift_title | string |
shift_title |
|
shift_description
|
shift.shift_description | string |
shift_description |
|
created_at
|
created_at | string |
created_at |
|
status
|
status | integer |
status |
|
arrival_time
|
arrival_time | string |
arrival_time |
|
departure_time
|
departure_time | string |
departure_time |
|
hours_approved_by
|
hours_approved_by | string |
hours_approved_by |
|
id
|
user.id | string |
id |
|
first_name
|
user.first_name | string |
first_name |
|
last_name
|
user.last_name | string |
last_name |
|
email
|
user.email | string |
|
|
gender
|
user.gender | integer |
gender |
|
address
|
user.address | string |
address |
|
phone_number
|
user.phone_number | string |
phone_number |
|
date_of_birth
|
user.date_of_birth | string |
date_of_birth |
|
timezone
|
user.timezone | string |
timezone |
|
address_coordinates
|
user.address_coordinates | array of string |
address_coordinates |
|
id
|
opportunity.id | string |
id |
|
status
|
opportunity.status | string |
status |
|
id
|
opportunity.category.id | string |
id |
|
title
|
opportunity.category.title | string |
title |
|
description
|
opportunity.category.description | string |
description |
|
title
|
opportunity.title | string |
title |
|
description
|
opportunity.description | string |
description |
Deleted Sequence Assigment
- Operation ID:
- DeletedSequence
Triggers when a user's assignment to a sequence is deleted
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
user_info.id | string |
id |
|
first_name
|
user_info.first_name | string |
first_name |
|
last_name
|
user_info.last_name | string |
last_name |
|
email
|
user_info.email | string |
|
|
gender
|
user_info.gender | integer |
gender |
|
address
|
user_info.address | string |
address |
|
phone_number
|
user_info.phone_number | string |
phone_number |
|
date_of_birth
|
user_info.date_of_birth | string |
date_of_birth |
|
timezone
|
user_info.timezone | string |
timezone |
|
address_coordinates
|
user_info.address_coordinates | array of string |
address_coordinates |
|
id
|
sequence_info.id | string |
id |
|
title
|
sequence_info.title | string |
title |
|
description
|
sequence_info.description | string |
description |
|
sequence_status
|
sequence_info.sequence_status | string |
sequence_status |
|
display_status
|
sequence_info.display_status | string |
display_status |
|
step_info
|
sequence_info.step_info | array of object |
step_info |
|
step
|
sequence_info.step_info.step | integer |
step |
|
type
|
sequence_info.step_info.type | string |
type |
|
orientation_details
|
sequence_info.step_info.orientation_details | array of object |
orientation_details |
|
title
|
sequence_info.step_info.orientation_details.title | string |
title |
|
description
|
sequence_info.step_info.orientation_details.description | string |
description |
|
status
|
sequence_info.step_info.orientation_details.user_orientation.status | string |
status |
|
completion_on
|
sequence_info.step_info.orientation_details.user_orientation.completion_on | string |
completion_on |
|
expiration_on
|
sequence_info.step_info.orientation_details.user_orientation.expiration_on | string |
expiration_on |
|
interview_details
|
sequence_info.step_info.interview_details | array of object |
interview_details |
|
title
|
sequence_info.step_info.interview_details.title | string |
title |
|
description
|
sequence_info.step_info.interview_details.description | string |
description |
|
interview
|
sequence_info.step_info.interview_details.user_interview.interview | string |
interview |
|
status
|
sequence_info.step_info.interview_details.user_interview.status | string |
status |
|
completion_on
|
sequence_info.step_info.interview_details.user_interview.completion_on | string |
completion_on |
|
expiration_on
|
sequence_info.step_info.interview_details.user_interview.expiration_on | string |
expiration_on |
|
status
|
status | string |
status |
|
created_at
|
created_at | string |
created_at |
|
updated_at
|
updated_at | string |
updated_at |
New Form Submission
- Operation ID:
- NewFormSubmission
Triggers when a user submits a Vome form
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
user.id | string |
id |
|
first_name
|
user.first_name | string |
first_name |
|
last_name
|
user.last_name | string |
last_name |
|
email
|
user.email | string |
|
|
gender
|
user.gender | string |
gender |
|
address
|
user.address | string |
address |
|
phone_number
|
user.phone_number | string |
phone_number |
|
date_of_birth
|
user.date_of_birth | string |
date_of_birth |
|
timezone
|
user.timezone | string |
timezone |
|
address_coordinates
|
user.address_coordinates | string |
address_coordinates |
|
submission_status
|
submission_status | string |
submission_status |
|
created_at
|
created_at | string |
created_at |
|
arrival_source
|
arrival_source | string |
arrival_source |
|
questions
|
questions | array of object |
questions |
|
id
|
questions.id | string |
id |
|
id
|
questions.question.id | string |
id |
|
title
|
questions.question.title | string |
title |
|
question_type
|
questions.question.question_type | string |
question_type |
|
options
|
questions.question.options | array of string |
options |
|
answer
|
questions.answer | string |
answer |
|
options
|
questions.options | array of string |
options |
|
responded
|
questions.responded | boolean |
responded |
|
medical_info
|
medical_info | string |
medical_info |
|
id
|
emergency_contact.id | string |
id |
|
name
|
emergency_contact.name | string |
name |
|
relationship
|
emergency_contact.relationship | string |
relationship |
|
phone_number
|
emergency_contact.phone_number | string |
phone_number |
|
digital_consent
|
digital_consent | array of object |
digital_consent |
|
id
|
digital_consent.id | string |
id |
|
digital_consent_info
|
digital_consent.digital_consent_info | string |
digital_consent_info |
|
attached_file
|
digital_consent.attached_file | string |
attached_file |
|
consent_status
|
digital_consent.consent_status | integer |
consent_status |
|
general_availability
|
general_availability | array of object |
general_availability |
|
id
|
general_availability.id | string |
id |
|
day
|
general_availability.day | integer |
day |
|
availability
|
general_availability.availability | string |
availability |
|
attachments
|
attachments | array of object |
attachments |
|
id
|
attachments.id | string |
id |
|
document_file
|
attachments.document_file | string |
document_file |
|
notes
|
attachments.notes | string |
notes |
|
id
|
attachments.attachment_info.id | string |
id |
|
title
|
attachments.attachment_info.title | string |
title |
|
description
|
attachments.attachment_info.description | string |
description |
|
opportunities
|
opportunities | array of |
opportunities |
|
name
|
folder.name | string |
name |
|
id
|
form.id | string |
id |
|
title
|
form.title | string |
title |
New Profile
- Operation ID:
- NewProfile
Triggers when new user is created
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
logged_hours
|
logged_hours | integer |
logged_hours |
|
is_offline
|
is_offline | boolean |
is_offline |
|
is_following
|
is_following | boolean |
is_following |
|
name
|
emergency_contact.name | string |
name |
|
phone_number
|
emergency_contact.phone_number | string |
phone_number |
|
relationship
|
emergency_contact.relationship | string |
relationship |
|
description
|
medical_information.description | string |
description |
|
has_medical_info
|
medical_information.has_medical_info | boolean |
has_medical_info |
|
first_name
|
profile_details.first_name | string |
first_name |
|
last_name
|
profile_details.last_name | string |
last_name |
|
full_name
|
profile_details.full_name | string |
full_name |
|
email
|
profile_details.email | string |
|
|
profile_image
|
profile_details.profile_image | string |
profile_image |
|
phone_number
|
profile_details.phone_number | string |
phone_number |
|
date_of_birth
|
profile_details.date_of_birth | string |
date_of_birth |
|
gender
|
profile_details.gender | string |
gender |
|
gender_text
|
profile_details.gender_text | string |
gender_text |
|
occupation
|
profile_details.occupation | string |
occupation |
|
occupation_institution_name
|
profile_details.occupation_institution_name | string |
occupation_institution_name |
|
skills
|
profile_details.skills | array of |
skills |
|
languages
|
profile_details.languages | array of |
languages |
|
address
|
profile_details.address | string |
address |
|
created_at
|
profile_details.created_at | string |
created_at |
|
age
|
profile_details.age | string |
age |
|
address_coordinates
|
profile_details.address_coordinates | array of |
address_coordinates |
|
opportunities
|
opportunities | array of object |
opportunities |
|
id
|
opportunities.id | string |
id |
|
id
|
opportunities.opportunity.id | string |
id |
|
title
|
opportunities.opportunity.title | string |
title |
|
id
|
opportunities.opportunity.category.id | string |
id |
|
title
|
opportunities.opportunity.category.title | string |
title |
|
most_recent_shift
|
most_recent_shift | string |
most_recent_shift |
|
completed_shifts
|
completed_shifts | integer |
completed_shifts |
|
profile_tags
|
profile_tags | array of object |
profile_tags |
|
id
|
profile_tags.id | string |
id |
|
id
|
profile_tags.tag.id | string |
id |
|
tag_title
|
profile_tags.tag.tag_title | string |
tag_title |
|
custom_fields
|
custom_fields | array of object |
custom_fields |
|
id
|
custom_fields.id | string |
id |
|
id
|
custom_fields.custom_field.id | string |
id |
|
field_type
|
custom_fields.custom_field.field_type | integer |
field_type |
|
is_active
|
custom_fields.custom_field.is_active | boolean |
is_active |
|
options
|
custom_fields.custom_field.options | array of object |
options |
|
id
|
custom_fields.custom_field.options.id | string |
id |
|
value
|
custom_fields.custom_field.options.value | string |
value |
|
order
|
custom_fields.custom_field.options.order | integer |
order |
|
custom_field_value
|
custom_fields.custom_field_value | array of object |
custom_field_value |
|
id
|
custom_fields.custom_field_value.id | string |
id |
|
id
|
custom_fields.custom_field_value.value.id | string |
id |
|
value
|
custom_fields.custom_field_value.value.value | string |
value |
|
order
|
custom_fields.custom_field_value.value.order | integer |
order |
New Reservation
- Operation ID:
- NewReservation
Triggers when a new reservation is scheduled
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
shift.id | string |
id |
|
created_at
|
shift.created_at | string |
created_at |
|
shift_start_at
|
shift.shift_start_at | string |
shift_start_at |
|
shift_end_at
|
shift.shift_end_at | string |
shift_end_at |
|
spots
|
shift.spots | integer |
spots |
|
shift_title
|
shift.shift_title | string |
shift_title |
|
shift_description
|
shift.shift_description | string |
shift_description |
|
created_at
|
created_at | string |
created_at |
|
status
|
status | integer |
status |
|
arrival_time
|
arrival_time | string |
arrival_time |
|
departure_time
|
departure_time | string |
departure_time |
|
hours_approved_by
|
hours_approved_by | string |
hours_approved_by |
|
id
|
user.id | string |
id |
|
first_name
|
user.first_name | string |
first_name |
|
last_name
|
user.last_name | string |
last_name |
|
email
|
user.email | string |
|
|
gender
|
user.gender | integer |
gender |
|
address
|
user.address | string |
address |
|
phone_number
|
user.phone_number | string |
phone_number |
|
date_of_birth
|
user.date_of_birth | string |
date_of_birth |
|
timezone
|
user.timezone | string |
timezone |
|
address_coordinates
|
user.address_coordinates | array of string |
address_coordinates |
|
id
|
opportunity.id | string |
id |
|
status
|
opportunity.status | string |
status |
|
id
|
opportunity.category.id | string |
id |
|
title
|
opportunity.category.title | string |
title |
|
description
|
opportunity.category.description | string |
description |
|
title
|
opportunity.title | string |
title |
|
description
|
opportunity.description | string |
description |
New Sequence Assigned
- Operation ID:
- NewSequence
Triggers when a user is assigned to a sequence
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
user_info.id | string |
id |
|
first_name
|
user_info.first_name | string |
first_name |
|
last_name
|
user_info.last_name | string |
last_name |
|
email
|
user_info.email | string |
|
|
gender
|
user_info.gender | integer |
gender |
|
address
|
user_info.address | string |
address |
|
phone_number
|
user_info.phone_number | string |
phone_number |
|
date_of_birth
|
user_info.date_of_birth | string |
date_of_birth |
|
timezone
|
user_info.timezone | string |
timezone |
|
address_coordinates
|
user_info.address_coordinates | array of string |
address_coordinates |
|
id
|
sequence_info.id | string |
id |
|
title
|
sequence_info.title | string |
title |
|
description
|
sequence_info.description | string |
description |
|
sequence_status
|
sequence_info.sequence_status | string |
sequence_status |
|
display_status
|
sequence_info.display_status | string |
display_status |
|
step_info
|
sequence_info.step_info | array of object |
step_info |
|
step
|
sequence_info.step_info.step | integer |
step |
|
type
|
sequence_info.step_info.type | string |
type |
|
orientation_details
|
sequence_info.step_info.orientation_details | array of object |
orientation_details |
|
title
|
sequence_info.step_info.orientation_details.title | string |
title |
|
description
|
sequence_info.step_info.orientation_details.description | string |
description |
|
status
|
sequence_info.step_info.orientation_details.user_orientation.status | string |
status |
|
completion_on
|
sequence_info.step_info.orientation_details.user_orientation.completion_on | string |
completion_on |
|
expiration_on
|
sequence_info.step_info.orientation_details.user_orientation.expiration_on | string |
expiration_on |
|
interview_details
|
sequence_info.step_info.interview_details | array of object |
interview_details |
|
title
|
sequence_info.step_info.interview_details.title | string |
title |
|
description
|
sequence_info.step_info.interview_details.description | string |
description |
|
interview
|
sequence_info.step_info.interview_details.user_interview.interview | string |
interview |
|
status
|
sequence_info.step_info.interview_details.user_interview.status | string |
status |
|
completion_on
|
sequence_info.step_info.interview_details.user_interview.completion_on | string |
completion_on |
|
expiration_on
|
sequence_info.step_info.interview_details.user_interview.expiration_on | string |
expiration_on |
|
status
|
status | string |
status |
|
created_at
|
created_at | string |
created_at |
|
updated_at
|
updated_at | string |
updated_at |
Updated Form Submission
- Operation ID:
- UpdatedFormSubmission
Triggers when a user's form submission is updated
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
user.id | string |
id |
|
first_name
|
user.first_name | string |
first_name |
|
last_name
|
user.last_name | string |
last_name |
|
email
|
user.email | string |
|
|
gender
|
user.gender | string |
gender |
|
address
|
user.address | string |
address |
|
phone_number
|
user.phone_number | string |
phone_number |
|
date_of_birth
|
user.date_of_birth | string |
date_of_birth |
|
timezone
|
user.timezone | string |
timezone |
|
address_coordinates
|
user.address_coordinates | string |
address_coordinates |
|
submission_status
|
submission_status | string |
submission_status |
|
created_at
|
created_at | string |
created_at |
|
arrival_source
|
arrival_source | string |
arrival_source |
|
questions
|
questions | array of object |
questions |
|
id
|
questions.id | string |
id |
|
id
|
questions.question.id | string |
id |
|
title
|
questions.question.title | string |
title |
|
question_type
|
questions.question.question_type | string |
question_type |
|
options
|
questions.question.options | array of string |
options |
|
answer
|
questions.answer | string |
answer |
|
options
|
questions.options | array of string |
options |
|
responded
|
questions.responded | boolean |
responded |
|
medical_info
|
medical_info | string |
medical_info |
|
id
|
emergency_contact.id | string |
id |
|
name
|
emergency_contact.name | string |
name |
|
relationship
|
emergency_contact.relationship | string |
relationship |
|
phone_number
|
emergency_contact.phone_number | string |
phone_number |
|
digital_consent
|
digital_consent | array of object |
digital_consent |
|
id
|
digital_consent.id | string |
id |
|
digital_consent_info
|
digital_consent.digital_consent_info | string |
digital_consent_info |
|
attached_file
|
digital_consent.attached_file | string |
attached_file |
|
consent_status
|
digital_consent.consent_status | integer |
consent_status |
|
general_availability
|
general_availability | array of object |
general_availability |
|
id
|
general_availability.id | string |
id |
|
day
|
general_availability.day | integer |
day |
|
availability
|
general_availability.availability | string |
availability |
|
attachments
|
attachments | array of object |
attachments |
|
id
|
attachments.id | string |
id |
|
document_file
|
attachments.document_file | string |
document_file |
|
notes
|
attachments.notes | string |
notes |
|
id
|
attachments.attachment_info.id | string |
id |
|
title
|
attachments.attachment_info.title | string |
title |
|
description
|
attachments.attachment_info.description | string |
description |
|
opportunities
|
opportunities | array of |
opportunities |
|
name
|
folder.name | string |
name |
|
id
|
form.id | string |
id |
|
title
|
form.title | string |
title |
Updated Reservation
- Operation ID:
- UpdatedReservation
Triggers when a user's reservation is updated
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
shift.id | string |
id |
|
created_at
|
shift.created_at | string |
created_at |
|
shift_start_at
|
shift.shift_start_at | string |
shift_start_at |
|
shift_end_at
|
shift.shift_end_at | string |
shift_end_at |
|
spots
|
shift.spots | integer |
spots |
|
shift_title
|
shift.shift_title | string |
shift_title |
|
shift_description
|
shift.shift_description | string |
shift_description |
|
created_at
|
created_at | string |
created_at |
|
status
|
status | integer |
status |
|
arrival_time
|
arrival_time | string |
arrival_time |
|
departure_time
|
departure_time | string |
departure_time |
|
hours_approved_by
|
hours_approved_by | string |
hours_approved_by |
|
id
|
user.id | string |
id |
|
first_name
|
user.first_name | string |
first_name |
|
last_name
|
user.last_name | string |
last_name |
|
email
|
user.email | string |
|
|
gender
|
user.gender | integer |
gender |
|
address
|
user.address | string |
address |
|
phone_number
|
user.phone_number | string |
phone_number |
|
date_of_birth
|
user.date_of_birth | string |
date_of_birth |
|
timezone
|
user.timezone | string |
timezone |
|
address_coordinates
|
user.address_coordinates | array of string |
address_coordinates |
|
id
|
opportunity.id | string |
id |
|
status
|
opportunity.status | string |
status |
|
id
|
opportunity.category.id | string |
id |
|
title
|
opportunity.category.title | string |
title |
|
description
|
opportunity.category.description | string |
description |
|
title
|
opportunity.title | string |
title |
|
description
|
opportunity.description | string |
description |
Updated Sequence
- Operation ID:
- UpdatedSequence
Triggers when a user's assigned sequence is updated
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
id
|
user_info.id | string |
id |
|
first_name
|
user_info.first_name | string |
first_name |
|
last_name
|
user_info.last_name | string |
last_name |
|
email
|
user_info.email | string |
|
|
gender
|
user_info.gender | integer |
gender |
|
address
|
user_info.address | string |
address |
|
phone_number
|
user_info.phone_number | string |
phone_number |
|
date_of_birth
|
user_info.date_of_birth | string |
date_of_birth |
|
timezone
|
user_info.timezone | string |
timezone |
|
address_coordinates
|
user_info.address_coordinates | array of string |
address_coordinates |
|
id
|
sequence_info.id | string |
id |
|
title
|
sequence_info.title | string |
title |
|
description
|
sequence_info.description | string |
description |
|
sequence_status
|
sequence_info.sequence_status | string |
sequence_status |
|
display_status
|
sequence_info.display_status | string |
display_status |
|
step_info
|
sequence_info.step_info | array of object |
step_info |
|
step
|
sequence_info.step_info.step | integer |
step |
|
type
|
sequence_info.step_info.type | string |
type |
|
orientation_details
|
sequence_info.step_info.orientation_details | array of object |
orientation_details |
|
title
|
sequence_info.step_info.orientation_details.title | string |
title |
|
description
|
sequence_info.step_info.orientation_details.description | string |
description |
|
status
|
sequence_info.step_info.orientation_details.user_orientation.status | string |
status |
|
completion_on
|
sequence_info.step_info.orientation_details.user_orientation.completion_on | string |
completion_on |
|
expiration_on
|
sequence_info.step_info.orientation_details.user_orientation.expiration_on | string |
expiration_on |
|
interview_details
|
sequence_info.step_info.interview_details | array of object |
interview_details |
|
title
|
sequence_info.step_info.interview_details.title | string |
title |
|
description
|
sequence_info.step_info.interview_details.description | string |
description |
|
interview
|
sequence_info.step_info.interview_details.user_interview.interview | string |
interview |
|
status
|
sequence_info.step_info.interview_details.user_interview.status | string |
status |
|
completion_on
|
sequence_info.step_info.interview_details.user_interview.completion_on | string |
completion_on |
|
expiration_on
|
sequence_info.step_info.interview_details.user_interview.expiration_on | string |
expiration_on |
|
status
|
status | string |
status |
|
created_at
|
created_at | string |
created_at |
|
updated_at
|
updated_at | string |
updated_at |
UpdatedProfile
- Operation ID:
- UpdatedProfile
Triggers when a profile is updated in your Vome database
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
events
|
events | array of string |
events |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
logged_hours
|
logged_hours | integer |
logged_hours |
|
is_offline
|
is_offline | boolean |
is_offline |
|
is_following
|
is_following | boolean |
is_following |
|
name
|
emergency_contact.name | string |
name |
|
phone_number
|
emergency_contact.phone_number | string |
phone_number |
|
relationship
|
emergency_contact.relationship | string |
relationship |
|
description
|
medical_information.description | string |
description |
|
has_medical_info
|
medical_information.has_medical_info | boolean |
has_medical_info |
|
first_name
|
profile_details.first_name | string |
first_name |
|
last_name
|
profile_details.last_name | string |
last_name |
|
full_name
|
profile_details.full_name | string |
full_name |
|
email
|
profile_details.email | string |
|
|
profile_image
|
profile_details.profile_image | string |
profile_image |
|
phone_number
|
profile_details.phone_number | string |
phone_number |
|
date_of_birth
|
profile_details.date_of_birth | string |
date_of_birth |
|
gender
|
profile_details.gender | string |
gender |
|
gender_text
|
profile_details.gender_text | string |
gender_text |
|
occupation
|
profile_details.occupation | string |
occupation |
|
occupation_institution_name
|
profile_details.occupation_institution_name | string |
occupation_institution_name |
|
skills
|
profile_details.skills | array of |
skills |
|
languages
|
profile_details.languages | array of |
languages |
|
address
|
profile_details.address | string |
address |
|
created_at
|
profile_details.created_at | string |
created_at |
|
age
|
profile_details.age | string |
age |
|
address_coordinates
|
profile_details.address_coordinates | array of |
address_coordinates |
|
opportunities
|
opportunities | array of object |
opportunities |
|
id
|
opportunities.id | string |
id |
|
id
|
opportunities.opportunity.id | string |
id |
|
title
|
opportunities.opportunity.title | string |
title |
|
id
|
opportunities.opportunity.category.id | string |
id |
|
title
|
opportunities.opportunity.category.title | string |
title |
|
most_recent_shift
|
most_recent_shift | string |
most_recent_shift |
|
completed_shifts
|
completed_shifts | integer |
completed_shifts |
|
profile_tags
|
profile_tags | array of object |
profile_tags |
|
id
|
profile_tags.id | string |
id |
|
id
|
profile_tags.tag.id | string |
id |
|
tag_title
|
profile_tags.tag.tag_title | string |
tag_title |
|
custom_fields
|
custom_fields | array of object |
custom_fields |
|
id
|
custom_fields.id | string |
id |
|
id
|
custom_fields.custom_field.id | string |
id |
|
field_type
|
custom_fields.custom_field.field_type | integer |
field_type |
|
is_active
|
custom_fields.custom_field.is_active | boolean |
is_active |
|
options
|
custom_fields.custom_field.options | array of object |
options |
|
id
|
custom_fields.custom_field.options.id | string |
id |
|
value
|
custom_fields.custom_field.options.value | string |
value |
|
order
|
custom_fields.custom_field.options.order | integer |
order |
|
custom_field_value
|
custom_fields.custom_field_value | array of object |
custom_field_value |
|
id
|
custom_fields.custom_field_value.id | string |
id |
|
id
|
custom_fields.custom_field_value.value.id | string |
id |
|
value
|
custom_fields.custom_field_value.value.value | string |
value |
|
order
|
custom_fields.custom_field_value.value.order | integer |
order |