Requirements
Connecting Pexip Engage takes an active account plus OAuth client credentials, granted by signing in with your account — no other setup is required.[3]
Get your Pexip Engage credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- EnterprisetextRequired
Enter the enterprise tenant slug assigned by Pexip Engage, for example
[1]acme. - Client IDtextRequired
Enter the OAuth client ID supplied by your account manager.
[1] - Client SecretpasswordRequired
Enter the OAuth client secret supplied by your account manager.
[1] - Additional Scopesarray
Add any extra OAuth scopes assigned to this client that are needed by future modules or custom API calls.
[1]
Connect Pexip Engage in WEXTL
- Log in to your WEXTL account, add the Pexip Engage 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 Pexip Engage 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 →
Pexip Engage node modules
The list below is a reference of every Pexip Engage node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Pexip Engage node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch Applied TemplatesTrigger
| Field | Type |
|---|---|
| Start date | text |
| End date | text |
| Availability template | object |
| ID | text |
| Time zone | time |
| Created at | date |
| Updated at | date |
Watch Availability TemplatesTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | text |
| Time zone | time |
| Employee | object |
| ID | text |
| Color | text |
| Order | number |
Watch Availability Time RangesTrigger
| Field | Type |
|---|---|
| ID | text |
| Day of week | text |
| Start time | text |
| End time | text |
| Availability template | object |
| ID | text |
| Created at | date |
| Updated at | date |
Watch Employee UnavailabilityTrigger
Watch Fetch ConfigurationsTrigger
| Field | Type |
|---|---|
| ID | text |
| Body | text |
| Mapping | array |
| Mapping | object |
| Endpoint | url |
| Method | text |
| Headers | array |
| Header | object |
| Created at | date |
Watch FilesTrigger
| Field | Type |
|---|---|
| ID | text |
| Blob name | text |
| Original file name | text |
| Scan result type | text |
| Created at | date |
| Updated at | date |
| Deleted at | date |
Watch Form QuestionsTrigger
| Field | Type |
|---|---|
| ID | text |
| Form | object |
| ID | text |
| Fetch configuration | object |
| ID | text |
| Order | number |
| Default value | text |
| External ID | text |
| Target property | text |
Watch FormsTrigger
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| Name | text |
| Type | text |
| Created at | date |
| Updated at | date |
| Deleted at | date |
Watch Lead SegmentsTrigger
| Field | Type |
|---|---|
| ID | text |
| Description | text |
| Code | text |
| Created at | date |
| Updated at | date |
| Deleted at | date |
Watch Listing Time SlotsTrigger
| Field | Type |
|---|---|
| ID | text |
| Listing | object |
| ID | text |
| Date | text |
| Start time | text |
| End time | text |
| Bookable | boolean |
| Assignments | array |
| Assignment | object |
Watch ListingsTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| External ID | text |
| Active | boolean |
| Internal notes | text |
| Tags | array |
| Tag | text |
Watch Meeting RoomsTrigger
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| Active | boolean |
| Capacity | number |
| Is wheel chair accessible | boolean |
| Name | text |
Watch New AppointmentsTrigger
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Watch New Callback RequestsTrigger
| Field | Type |
|---|---|
| ID | text |
| Answers | array |
| Answer | object |
| Callback request participants | array |
| Callback request participant | object |
| Listing | object |
| ID | text |
| Lead segment | object |
| ID | text |
| Meeting type | text |
| Metadata | text |
Watch New CustomersTrigger
| Field | Type |
|---|---|
| Customer ID | text |
| Customer external ID | text |
| Customer number | text |
| Customer email | |
| Customer first name | text |
| Customer last name | text |
| Customer company | text |
Watch New EmployeesTrigger
| Field | Type |
|---|---|
| ID | text |
| Function | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Communication email | text |
| External ID | text |
| Username | text |
| First name | text |
Watch New External Calendar EventsTrigger
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| External calendar | object |
| ID | text |
| Start | date |
| End | date |
| All day | boolean |
| Show as | text |
Watch OfficesTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Directions | object |
| Language | text |
| Value | text |
| Parking info | object |
| Language | text |
| Value | text |
| External ID | text |
Watch Subject GroupsTrigger
| Field | Type |
|---|---|
| ID | text |
| Color | text |
| Order | number |
| External ID | text |
| Image | url |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
Watch SubjectsTrigger
| Field | Type |
|---|---|
| ID | text |
| Enabled for internal use | boolean |
| Enabled for customer use | boolean |
| Order | number |
| External ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
Watch UnavailabilityTrigger
Get a Callback RequestAction
Get a ContextAction
Get a CustomerAction
Get a Fetch ConfigurationAction
Get a FileAction
Get a FormAction
Get a Form QuestionAction
Get a Lead SegmentAction
Get a ListingAction
Get a Listing Time SlotAction
Get a Meeting RoomAction
Get a Plugin Edit URLAction
| Field | Type |
|---|---|
IntentRequired | choice |
TokenRequired | text |
Get a Profile Picture Upload URLAction
Get a SubjectAction
Get a Subject GroupAction
Get a Video Meeting URLAction
| Field | Type |
|---|---|
TokenRequired | text |
Get a Video Test Meeting URLAction
| Field | Type |
|---|---|
TokenRequired | text |
Get an AppointmentAction
Get an Availability TemplateAction
Get an Availability Time RangeAction
Get an EmployeeAction
Get an OfficeAction
Get Enterprise SettingsAction
No fields documented.
Get Listing Scheduling SettingsAction
Get the TimetableAction
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
| Employee ID | choice |
| Employee languages | array |
| Employee languages | choice |
OfficeRequired | choice |
SubjectRequired | choice |
Meeting typeRequired | choice |
| Field | Type |
|---|---|
| Duration | number |
| Earliest possible | date |
| Latest possible | date |
| Listing | object |
| ID | text |
| Meeting type | text |
| Office | object |
| ID | text |
| Slots | array |
| Slot | object |
List Applied TemplatesSearch
List AppointmentsSearch
| Field | Type |
|---|---|
| Appointments | choice |
| External ID | array |
| External ID | text |
| From | date |
| To | date |
| Created from date | date |
| Created to date | date |
| Meeting type | array |
| Meeting type | choice |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
List Availability TemplatesSearch
List Availability Time RangesSearch
List Callback RequestsSearch
| Field | Type |
|---|---|
| Callback requests | choice |
| Created from date | date |
| Created to date | date |
| External ID | array |
| External ID | text |
| Meeting type | array |
| Meeting type | choice |
| Status | array |
| Status | choice |
| Listing ID | choice |
| Field | Type |
|---|---|
| ID | text |
| Answers | array |
| Answer | object |
| Callback request participants | array |
| Callback request participant | object |
| Listing | object |
| ID | text |
| Lead segment | object |
| ID | text |
| Meeting type | text |
| Metadata | text |
List CustomersSearch
| Field | Type |
|---|---|
| Customer IDs | choice |
| Customer external IDs | array |
| Customer external ID | text |
| Customer numbers | array |
| Customer number | text |
| Search | text |
| Include deleted customers | boolean |
LimitRequired | number |
| Field | Type |
|---|---|
| Customer ID | text |
| Customer external ID | text |
| Customer number | text |
| Customer email | |
| Customer first name | text |
| Customer last name | text |
| Customer company | text |
List Defined AvailabilitySearch
| Field | Type |
|---|---|
FromRequired | date |
ToRequired | date |
| Employee ID | choice |
OfficeRequired | choice |
| Subject ID | choice |
| Meeting type | array |
| Meeting type | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Start | date |
| End | date |
| Employee | object |
| ID | text |
| Office | object |
| ID | text |
| Subject | object |
| ID | text |
| Meeting type | text |
| Force manual accept | boolean |
List Employee UnavailabilitySearch
List EmployeesSearch
| Field | Type |
|---|---|
| Employees | choice |
| array | |
| External ID | array |
| External ID | text |
| Available role | array |
| Available role | choice |
| Username | array |
| Username | text |
| Status | array |
| Status | choice |
| With deleted | boolean |
| Field | Type |
|---|---|
| ID | text |
| Function | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Communication email | text |
| External ID | text |
| Username | text |
| First name | text |
List ExpertisesSearch
List External Calendar EventsSearch
| Field | Type |
|---|---|
| External calendar ID | text |
| Show as | array |
| Show as | choice |
| External calendar event IDs | array |
| External calendar event IDs | text |
FromRequired | date |
ToRequired | date |
EmployeeRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| External ID | text |
| External calendar | object |
| ID | text |
| Start | date |
| End | date |
| All day | boolean |
| Show as | text |
List Favorite AgentsSearch
List Fetch ConfigurationsSearch
List FilesSearch
| Field | Type |
|---|---|
| Files | choice |
| Original file name | array |
| Original file name | text |
| Blob name | array |
| Blob name | text |
| Scan result type | array |
| Scan result type | choice |
| With deleted | boolean |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Blob name | text |
| Original file name | text |
| Scan result type | text |
| Created at | date |
| Updated at | date |
| Deleted at | date |
List Form QuestionsSearch
List FormsSearch
List Lead Segment Scheduling SettingsSearch
List Lead SegmentsSearch
List Listing Time SlotsSearch
List ListingsSearch
| Field | Type |
|---|---|
| Listings | choice |
| External ID | array |
| External ID | text |
| Active | boolean |
| Tag | array |
| Tag | text |
| With deleted | boolean |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| External ID | text |
| Active | boolean |
| Internal notes | text |
| Tags | array |
| Tag | text |
List Meeting RoomsSearch
List Office Coverage RegionsSearch
List Office Scheduling SettingsSearch
List Office Subject Availability SettingsSearch
List Office Subject Coverage RegionsSearch
List OfficesSearch
| Field | Type |
|---|---|
| Offices | choice |
| External ID | array |
| External ID | text |
| Active | boolean |
| Virtual | boolean |
| Employee ID | choice |
| Employee external ID | array |
| Employee external ID | text |
| Employee relation role | array |
| Employee relation role | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Directions | object |
| Language | text |
| Value | text |
| Parking info | object |
| Language | text |
| Value | text |
| External ID | text |
List RegionsSearch
List Schedulable EmployeesSearch
| Field | Type |
|---|---|
| Employee ID | choice |
| Employee external ID | array |
| Employee external ID | text |
| Lead segment | choice |
| Lead segment code | text |
| Listing | choice |
| Listing external ID | text |
| Location | object |
| Latitude | text |
| Longitude | text |
| Field | Type |
|---|---|
| ID | text |
| Function | object |
| Language | text |
| Value | text |
| Communication email | text |
| External ID | text |
| First name | text |
| Last name | text |
| Language | text |
List Schedulable Meeting TypesSearch
List Schedulable OfficesSearch
| Field | Type |
|---|---|
| Employee ID | choice |
| Employee external ID | array |
| Employee external ID | text |
| Lead segment | choice |
| Lead segment code | text |
| Listing | choice |
| Listing external ID | text |
| Location | object |
| Latitude | text |
| Longitude | text |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Directions | object |
| Language | text |
| Value | text |
| Parking info | object |
| Language | text |
| Value | text |
| Distance | number |
| External ID | text |
List Schedulable SubjectsSearch
| Field | Type |
|---|---|
| Employee ID | choice |
| Employee external ID | array |
| Employee external ID | text |
| Lead segment | choice |
| Lead segment code | text |
| Listing | choice |
| Listing external ID | text |
| Location | object |
| Latitude | text |
| Longitude | text |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Instructions | object |
| Language | text |
| Value | text |
| External ID | text |
| Order | number |
| Subject group | object |
| ID | text |
| Color | text |
| Order | number |
| External ID | text |
| Image | url |
| Translations | object |
| Name | object |
List Subject Availability SettingsSearch
List Subject GroupsSearch
List Subject Office Scheduling SettingsSearch
List Subject Scheduling SettingsSearch
List SubjectsSearch
| Field | Type |
|---|---|
| Subjects | choice |
| External ID | array |
| External ID | text |
| Enabled for internal use | boolean |
| Enabled for customer use | boolean |
| With deleted | boolean |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Enabled for internal use | boolean |
| Enabled for customer use | boolean |
| Order | number |
| External ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
List Time Range Availability SettingsSearch
List UnavailabilitySearch
Accept an AppointmentAction
Add an Appointment to Google CalendarAction
| Field | Type |
|---|---|
TokenRequired | text |
Add an Appointment to Office 365 CalendarAction
| Field | Type |
|---|---|
TokenRequired | text |
Apply an Availability TemplateAction
Cancel an AppointmentAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
| Answers | array |
| Answers | object |
| Message | text |
| Message for customer | text |
| User communication | object |
| Notifications | choice |
| Reminders | choice |
| Notifications override current action | choice |
| Updated by type | choice |
| Updated by ID | text |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Complete an AppointmentAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
| Start | date |
| End | date |
| Answers | array |
| Answers | object |
| No show | boolean |
| User communication | object |
| Notifications | choice |
| Reminders | choice |
| Notifications override current action | choice |
| Updated by type | choice |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Create a Callback RequestAction
| Field | Type |
|---|---|
| Answers | array |
| Answers | object |
Callback request participantsRequired | array |
| Callback request participants | object |
| Internal notes | text |
| Lead segment | choice |
| Listing | choice |
| Location | object |
| Postal code | text |
Country codeRequired | text |
| Geolocation | object |
TranslationsRequired | object |
Meeting typeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Answers | array |
| Answer | object |
| Callback request participants | array |
| Callback request participant | object |
| Listing | object |
| ID | text |
| Lead segment | object |
| ID | text |
| Meeting type | text |
| Metadata | text |
Create a ContextAction
| Field | Type |
|---|---|
| External ID | text |
| Appointment external ID | text |
| End | date |
| Metadata | text |
| Employees | choice |
| Secondary employees | choice |
| Subjects | choice |
| Field | Type |
|---|---|
| External ID | text |
| Appointment external ID | text |
| End | date |
| Metadata | text |
| Employee IDs | array |
| Employee ID | text |
| Secondary employee IDs | array |
| Secondary employee ID | text |
| Subject IDs | array |
| Subject ID | text |
Create a CustomerAction
| Field | Type |
|---|---|
| Customer external ID | text |
| Customer number | text |
| Customer email | |
| Customer first name | text |
| Customer last name | text |
| Customer company | text |
| Customer language | choice |
| Field | Type |
|---|---|
| Customer ID | text |
| Customer external ID | text |
| Customer number | text |
| Customer email | |
| Customer first name | text |
| Customer last name | text |
| Customer company | text |
Create a Fetch ConfigurationAction
Create a FormAction
Create a Form QuestionAction
| Field | Type |
|---|---|
FormRequired | choice |
| Default value | text |
| External ID | text |
| Target property | text |
| Required | boolean |
| Hidden | boolean |
Input typeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Form | object |
| ID | text |
| Fetch configuration | object |
| ID | text |
| Order | number |
| Default value | text |
| External ID | text |
| Target property | text |
Create a Lead SegmentAction
Create a ListingAction
| Field | Type |
|---|---|
| External ID | text |
| Active | boolean |
| Internal notes | text |
| Tags | array |
| Tags | text |
TranslationsRequired | object |
NameRequired | array |
| Description | array |
| Time zone | time |
| Location | object |
| Postal code | text |
Country codeRequired | text |
| Geolocation | object |
TranslationsRequired | object |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| External ID | text |
| Active | boolean |
| Internal notes | text |
| Tags | array |
| Tag | text |
Create a Listing Time SlotAction
| Field | Type |
|---|---|
ListingRequired | choice |
DateRequired | date |
Start timeRequired | date |
End timeRequired | date |
BookableRequired | boolean |
AssignmentsRequired | array |
| Assignments | object |
| Field | Type |
|---|---|
| ID | text |
| Listing | object |
| ID | text |
| Date | text |
| Start time | text |
| End time | text |
| Bookable | boolean |
| Assignments | array |
| Assignment | object |
Create a SubjectAction
| Field | Type |
|---|---|
| External ID | text |
TranslationsRequired | object |
NameRequired | array |
| Description | array |
| Instructions | array |
| Order | number |
Subject groupRequired | choice |
| Enabled for internal use | boolean |
| Enabled for customer use | boolean |
| Cancellation by agent form | choice |
| Field | Type |
|---|---|
| ID | text |
| Enabled for internal use | boolean |
| Enabled for customer use | boolean |
| Order | number |
| External ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
Create a Subject GroupAction
Create an AppointmentAction
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
SubjectRequired | choice |
OfficeRequired | choice |
Appointment participantsRequired | array |
| Appointment participants | object |
| Answers | array |
| Answers | object |
| Callback request | choice |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Create an Appointment InviteAction
| Field | Type |
|---|---|
SubjectRequired | choice |
OfficeRequired | choice |
Appointment participantsRequired | array |
| Appointment participants | object |
| Callback request | choice |
| Location | object |
| Postal code | text |
Country codeRequired | text |
| Geolocation | object |
TranslationsRequired | object |
| Listing | choice |
| Lead segment | choice |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Create an Availability TemplateAction
Create an Availability Time RangeAction
Create an EmployeeAction
| Field | Type |
|---|---|
| Communication email | text |
| External ID | text |
| Username | text |
First nameRequired | text |
Last nameRequired | text |
| Static video URL | url |
| Phone number | text |
| Field | Type |
|---|---|
| ID | text |
| Function | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Communication email | text |
| External ID | text |
| Username | text |
| First name | text |
Create an OfficeAction
| Field | Type |
|---|---|
| External ID | text |
| Phone number | text |
| Metadata | text |
| Active | boolean |
| Virtual | boolean |
| Time zone | time |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Directions | object |
| Language | text |
| Value | text |
| Parking info | object |
| Language | text |
| Value | text |
| External ID | text |
Create an Unavailability EventAction
Create UnavailabilityAction
Delete a CustomerAction
| Field | Type |
|---|---|
CustomerRequired | choice |
Delete a Fetch ConfigurationAction
| Field | Type |
|---|---|
Fetch configurationRequired | choice |
Delete a FormAction
| Field | Type |
|---|---|
FormRequired | choice |
Delete a Form QuestionAction
| Field | Type |
|---|---|
FormRequired | choice |
Delete a Lead SegmentAction
| Field | Type |
|---|---|
Lead segmentRequired | choice |
Delete a ListingAction
| Field | Type |
|---|---|
ListingRequired | choice |
Delete a Listing Time SlotAction
| Field | Type |
|---|---|
ListingRequired | choice |
Delete a SubjectAction
| Field | Type |
|---|---|
SubjectRequired | choice |
Delete a Subject GroupAction
| Field | Type |
|---|---|
Subject groupRequired | choice |
Delete an Availability TemplateAction
| Field | Type |
|---|---|
EmployeeRequired | choice |
Delete an Availability Time RangeAction
| Field | Type |
|---|---|
EmployeeRequired | choice |
Delete an EmployeeAction
| Field | Type |
|---|---|
EmployeeRequired | choice |
Delete an OfficeAction
| Field | Type |
|---|---|
OfficeRequired | choice |
Delete UnavailabilityAction
Download a FileAction
Download an Appointment iCal FileAction
Export Appointments as CSVAction
Export Conversion Analytics Sessions as CSVAction
Link a Meeting Room to an OfficeAction
| Field | Type |
|---|---|
OfficeRequired | choice |
Make an API Calluniversal
Reassign an AppointmentAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
OfficeRequired | choice |
Primary employeeRequired | choice |
| Message | text |
| Message for customer | text |
| User communication | object |
| Notifications | choice |
| Reminders | choice |
| Notifications override current action | choice |
| Updated by type | choice |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Reopen an AppointmentAction
Request an Appointment RescheduleAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
| Message | text |
| Message for customer | text |
| User communication | object |
| Notifications | choice |
| Reminders | choice |
| Notifications override current action | choice |
| Updated by type | choice |
| Updated by ID | text |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Reschedule an AppointmentAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
StartRequired | date |
EndRequired | date |
| Message | text |
| Message for customer | text |
| Answers | array |
| Answers | object |
| User communication | object |
| Notifications | choice |
| Reminders | choice |
| Notifications override current action | choice |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Reset an EmployeeAction
| Field | Type |
|---|---|
EmployeeRequired | choice |
Revert Applied TemplatesAction
| Field | Type |
|---|---|
EmployeeRequired | choice |
Start dateRequired | date |
End dateRequired | date |
| Type | choice |
Revert UnavailabilityAction
Set an Employee's ExpertiseAction
Unlink a Meeting Room from an OfficeAction
| Field | Type |
|---|---|
OfficeRequired | choice |
Update a Callback RequestAction
Update a CustomerAction
| Field | Type |
|---|---|
CustomerRequired | choice |
| Customer external ID | text |
| Customer number | text |
| Customer email | |
| Customer first name | text |
| Customer last name | text |
| Customer company | text |
| Field | Type |
|---|---|
| Customer ID | text |
| Customer external ID | text |
| Customer number | text |
| Customer email | |
| Customer first name | text |
| Customer last name | text |
| Customer company | text |
Update a Fetch ConfigurationAction
Update a FormAction
Update a Form QuestionAction
| Field | Type |
|---|---|
FormRequired | choice |
| Default value | text |
| External ID | text |
| Target property | text |
| Required | boolean |
| Hidden | boolean |
| Input type | choice |
| Field | Type |
|---|---|
| ID | text |
| Form | object |
| ID | text |
| Fetch configuration | object |
| ID | text |
| Order | number |
| Default value | text |
| External ID | text |
| Target property | text |
Update a Lead SegmentAction
Update a ListingAction
| Field | Type |
|---|---|
ListingRequired | choice |
| External ID | text |
| Active | boolean |
| Internal notes | text |
| Tags | array |
| Tags | text |
| Translations | object |
| Name | array |
| Description | array |
| Time zone | time |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| External ID | text |
| Active | boolean |
| Internal notes | text |
| Tags | array |
| Tag | text |
Update a Listing Time SlotAction
| Field | Type |
|---|---|
ListingRequired | choice |
DateRequired | date |
Start timeRequired | date |
End timeRequired | date |
BookableRequired | boolean |
AssignmentsRequired | array |
| Assignments | object |
| Field | Type |
|---|---|
| ID | text |
| Listing | object |
| ID | text |
| Date | text |
| Start time | text |
| End time | text |
| Bookable | boolean |
| Assignments | array |
| Assignment | object |
Update a SubjectAction
| Field | Type |
|---|---|
SubjectRequired | choice |
| External ID | text |
| Translations | object |
| Name | array |
| Description | array |
| Instructions | array |
| Order | number |
| Subject group | choice |
| Enabled for internal use | boolean |
| Enabled for customer use | boolean |
| Field | Type |
|---|---|
| ID | text |
| Enabled for internal use | boolean |
| Enabled for customer use | boolean |
| Order | number |
| External ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
Update a Subject GroupAction
| Field | Type |
|---|---|
Subject groupRequired | choice |
| External ID | text |
| Image | url |
| Translations | object |
| Name | array |
| Description | array |
| Color | text |
| Order | number |
| Field | Type |
|---|---|
| ID | text |
| Color | text |
| Order | number |
| External ID | text |
| Image | url |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
Update an AppointmentAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
| Appointment participants | array |
| Appointment participants | object |
| Answers | array |
| Answers | object |
| Callback request | choice |
| Location | object |
| Postal code | text |
Country codeRequired | text |
| Geolocation | object |
TranslationsRequired | object |
| Listing | choice |
| Lead segment | choice |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Update an Availability TemplateAction
Update an Availability Time RangeAction
Update an EmployeeAction
| Field | Type |
|---|---|
EmployeeRequired | choice |
| Communication email | text |
| External ID | text |
| Username | text |
| First name | text |
| Last name | text |
| Static video URL | url |
| Field | Type |
|---|---|
| ID | text |
| Function | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Communication email | text |
| External ID | text |
| Username | text |
| First name | text |
Update an OfficeAction
| Field | Type |
|---|---|
OfficeRequired | choice |
| External ID | text |
| Phone number | text |
| Metadata | text |
| Active | boolean |
| Virtual | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Language | text |
| Value | text |
| Description | object |
| Language | text |
| Value | text |
| Directions | object |
| Language | text |
| Value | text |
| Parking info | object |
| Language | text |
| Value | text |
| External ID | text |
Update Appointment DetailsAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
| Start | date |
| End | date |
| Office | choice |
| Appointment participants | array |
| Appointment participants | object |
| Answers | array |
| Answers | object |
| User communication | object |
| Notifications | choice |
| Reminders | choice |
| Notifications override current action | choice |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Update Enterprise SettingsAction
No fields documented.
Update ExpertisesAction
Update Favorite AgentsAction
Update Lead Segment Scheduling SettingsAction
Update Listing Scheduling SettingsAction
Update Office Coverage RegionsAction
Update Office Scheduling SettingsAction
Update Office Subject Availability SettingsAction
Update Office Subject Coverage RegionsAction
Update Subject Availability SettingsAction
Update Subject Office Scheduling SettingsAction
Update Subject Scheduling SettingsAction
Update the Location of an On-Location AppointmentAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
LocationRequired | object |
| Postal code | text |
Country codeRequired | text |
| Geolocation | object |
TranslationsRequired | object |
| Message for customer | text |
| User communication | object |
| Notifications | choice |
| Reminders | choice |
| Notifications override current action | choice |
| Updated by type | choice |
| Updated by ID | text |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Update the Meeting Type of an AppointmentAction
| Field | Type |
|---|---|
AppointmentRequired | choice |
Meeting typeRequired | choice |
| Location | object |
| Postal code | text |
Country codeRequired | text |
| Geolocation | object |
TranslationsRequired | object |
| Message for customer | text |
| User communication | object |
| Notifications | choice |
| Reminders | choice |
| Notifications override current action | choice |
| Updated by type | choice |
| Updated by ID | text |
| Field | Type |
|---|---|
| ID | text |
| Uuid | text |
| External ID | text |
| Start | date |
| End | date |
| Subject | object |
| ID | text |
| Office | object |
| ID | text |
Update Time Range Availability SettingsAction
Templates
Look for Pexip Engage templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Bookeo[2]Online booking and appointment scheduling platform for tours, classes, and service businesses.
- Anny Customer APIOnline booking and scheduling platform that lets customers book resources, services, and appointments in real time.
- BookedSchedulerResource reservation and scheduling platform for booking rooms, equipment, and shared assets.
- Anny Admin APIOnline booking and scheduling platform for managing services, resources, timeslots, and customer appointments.
- Appointment ReminderCreate, retrieve and manage appointments and their automated phone, SMS and email reminders in Appointment Reminder.
References
- WEXTL® Pexip Engage Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Pexip Engage.
- WEXTL® visual workflow builder data.
Last updated: Oct 18, 2026 14:33