Requirements
Before you set up the credential, make sure you have an active Bookwhen account and an API access token from your account settings ready.[3]
Get your Bookwhen credentials
- API KeypasswordRequired
Login to Bookwhen, go to Account Settings → API Tokens → create or copy your token for API authentication.
[1]
Connect Bookwhen in WEXTL
- Log in to your WEXTL account, add the Bookwhen 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 Bookwhen 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 →
Bookwhen node modules
The list below is a reference of every Bookwhen node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Bookwhen node module below opens to reveal its input parameters, outputs, and connection requirements.
Get a Class PassAction
Get a LeaderAction
Get a LocationAction
Get a TicketAction
Input fields[3]
| Field | Type |
|---|---|
Event IDRequired | choice |
| Include | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Details | text |
| Number issued | number |
| Number taken | number |
| Course ticket | boolean |
| Group ticket | boolean |
| Group min | number |
| Group max | number |
| Available | boolean |
| Available from | date |
| Relationships | object |
| Events | object |
| Class passes | object |
| Links | object |
| Self | text |
| Included | array |
Get an AttachmentAction
Get an EventAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | choice |
| Include | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Details | text |
| All day | boolean |
| Start at | date |
| End at | date |
| Attendee limit | number |
| Attendee count | number |
| Waiting list | boolean |
| Max tickets per booking | number |
| Tags | array |
| Relationships | object |
| Location | object |
| Attachments | object |
| Tickets | object |
| Leaders | object |
| Links | object |
| Self | text |
| Included | array |
List AttachmentsSearch
List Class PassesSearch
Input fields[3]
| Field | Type |
|---|---|
| Title | text |
| Detail | text |
| Usage Type | choice |
| Cost | object |
| Greater Than | number |
| Greater Than or Equal | number |
| Less Than | number |
| Less Than or Equal | number |
| Equal To | number |
| Usage Allowance | object |
| Greater Than | number |
| Greater Than or Equal | number |
| Less Than | number |
| Less Than or Equal | number |
| Equal To | number |
| Use Restricted For Days | object |
| Greater Than | number |
| Greater Than or Equal | number |
| Less Than | number |
| Less Than or Equal | number |
| Equal To | number |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Details | text |
| Usage allowance | number |
| Usage type | text |
| Number available | number |
| Use restricted for days | number |
| Links | object |
| Self | url |
List EventsSearch
Input fields[3]
| Field | Type |
|---|---|
| Calendar | text |
| Entry | text |
| Location | array |
| Location Slug | text |
| Tag | array |
| Tag Word | text |
| Title | array |
| Entry Title | text |
| Detail | array |
| Entry Detail | text |
| From | text |
| To | text |
| Compact | boolean |
| Include | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Details | text |
| All day | boolean |
| Start at | date |
| End at | date |
| Attendee limit | number |
| Attendee count | number |
| Waiting list | boolean |
| Max tickets per booking | number |
| Tags | array |
| Relationships | object |
| Location | object |
| Attachments | object |
| Tickets | object |
| Leaders | object |
| Links | object |
| Self | text |
| Included | array |
List LeadersSearch
List LocationsSearch
List TicketsSearch
Input fields[3]
| Field | Type |
|---|---|
Event IDRequired | choice |
| Include Additional Resources | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Details | text |
| Number issued | number |
| Number taken | number |
| Course ticket | boolean |
| Group ticket | boolean |
| Group min | number |
| Group max | number |
| Available | boolean |
| Available from | date |
| Relationships | object |
| Events | object |
| Class passes | object |
| Links | object |
| Self | text |
| Included | array |
Templates
Look for Bookwhen templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Acuity Scheduling[2]Online appointment scheduling for service businesses and calendars.
- AppointeddOnline booking and appointment scheduling for retail and service businesses.
- AmeliaWordPress booking and appointment scheduling for services and events.
- AxisRoomsHotel channel manager for OTA inventory, rates, restrictions, and booking distribution.
- AmenitizAll-in-one hotel management platform for bookings, channels, and guests.
References
- WEXTL® Bookwhen Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Bookwhen.
- WEXTL® visual workflow builder data.
Last updated: Jul 21, 2026 15:22