wbb-gladstone v0.0.9
Responses Provided
Provide a list of the responses provided as part of this integration. This should be a list of response name, and its description. | Response Name | Purpose | |------------|---------| | Gladstone Deep Link | Example of a Response using the Deep Link Handler | | Gladstone Bookings | Example of a Response using the Bookings handler | | Gladstone Authentication | Example of a Response using the Authentication handler. This is also the response used by the handlers that require authentication, to automatically redirect before handling rest of function | | Gladstone Cancel | An example of a Response using the Cancel Booking handler, also the Response used when clicking cancel on a booking found in the Bookings handler | | Gladstone book | The Response used for the in-chat booking choice, that can optionally be displayed using the deep link handler | | gladstone param failure | This Response is shown if one or more required function args/parameters are missing, for example secret and client ids | | Gladstone No Activity | The default Response shown when no activities are found | | gladstone no user | The default response shown when no user is found during authentication | | gladstone booking success | The default response shown when in-chat booking was successful | | gladstone booking failed | The defauls response shown when in-chat booking failed |
Handler Names
The following handler names and their functions are available :
| Handler Name | Purpose |
|---|---|
| Deep Link | Finds activities and generates deep link buttons to book a session |
| Authenticate | Authenticates user, based on membership id, and one other factor, home email by default |
| Bookings | Finds users past or future bookings |
| Cancel booking | Cancels any one future booking |
Configuration Options
( Provide a list of the configuration options for each of the handlers mentioned above )
Within the function there are a number of options that can be set to configure the behaviour of the integration. The tables below show the settings that are available for each handler.
Authenticate
| Property | Required | Description |
|---|---|---|
| domain | true | The client subdomain for the endpoint, for example thirdpartyintegration-test in https://thirdpartyintegration-test.gladstonesoftware.cloud/ |
| clientId | true | Client id required to authenticate with the api. Should be supplied by Gladstone |
| secret | true | Client secret required to authenticate with the api. Should be supplied by Gladstone |
| membershipNrField | false | The name of the question where the users membership number is found, defaults to gladstoneMembershipNr |
| otherField | false | The name of the question where the users other authentication value is found, defaults to gladstoneHomeEmail |
| otherFieldName | false | The user field that the otherField is compared to, must be present in the Gladstone Member Search result, defaults to homeEmail |
| nextBlock | false | The Response to display after authentication is successful, if set on the default response, this may override the config set by other handlers |
| noUserBlock | false | The Response to display if no users are found, defaults to gladstone-no-user |
Deep Link
| Property | Required | Description |
|---|---|---|
| domain | true | The client subdomain for the endpoint, for example thirdpartyintegration-test in https://thirdpartyintegration-test.gladstonesoftware.cloud/ |
| clientId | true | Client id required to authenticate with the api. Should be supplied by Gladstone |
| secret | true | Client secret required to authenticate with the api. Should be supplied by Gladstone |
| siteids | false | List of site ids to query activities with, formatted as an array of string, for example ["WIN", "CHE"] |
| activity | false | The name of the activity to look for, this can be hardcoded, or set to a template using %%, for example %%activityForm%% to use form values or variables from other integrations |
| fromDate | false | The start date of the activity session, can be set to a template, to use form values or variables from other integrations. If this is not set, all activities are returned |
| searchDayLimit | false | Limit of how many days to display sessions for, if you only want the sessions for the specified date and time, set this to 1. If set to 0, all sessions are displayed |
| noActivityResponse | false | The Response to display if no activities are found. Defaults to Gladstone No Activity |
| activitiesMessage | false | The Message to display preceding the gallery of available activities, defaults to Here is what I've found: |
| onlyFirstSession | false | If set, will only display the first available session, this can be useful if another integration has been used to find activities beforehand |
| deepLink | false | If set, will display a choice that deep links to Gladstone portal, for the specified activity |
| deepLinkChoice | false | The text to display on the deepLink choice, defaults to Book in Gladstone GO |
| chatBook | false | If set, will display a choice that books the activity for an authenticated user in the chat |
| chatBookChoice | false | The text to display on the chatBook choice, defaults to Book in chat |
| bookSuccessResponse | false | The response to display when in-chat booking was successful, defaults to gladstone-booking-success |
| bookFailResponse | false | The response to display when in-chat booking failed, defaults to gladstone-booking-failed |
Cancel Booking
| Property | Required | Description |
|---|---|---|
| domain | true | The client subdomain for the endpoint, for example thirdpartyintegration-test in https://thirdpartyintegration-test.gladstonesoftware.cloud/ |
| clientId | true | Client id required to authenticate with the api. Should be supplied by Gladstone |
| secret | true | Client secret required to authenticate with the api. Should be supplied by Gladstone |
| bookingIdField | false | The name of the question of argument field containing the booking id, defaults to %%bookingId%%, overriding this in the default Response can cause the Bookings handler cancel option to stop working, as this field is usually supplied by this handler |
| cancelSuccessResponse | false | The Response to show once cancellation has gone through successfully, defaults to menu |
| cancelFailResponse | false | The Response to show if cancellation failed, defaults to gladstone-no-activities |
Bookings
| Property | Required | Description |
|---|---|---|
| domain | true | The client subdomain for the endpoint, for example thirdpartyintegration-test in https://thirdpartyintegration-test.gladstonesoftware.cloud/ |
| clientId | true | Client id required to authenticate with the api. Should be supplied by Gladstone |
| secret | true | Client secret required to authenticate with the api. Should be supplied by Gladstone |
| noBookingsResponse | false | The Response shown if no bookings are found, defaults to gladstone-no-activities |
| past | false | If set, this handler finds past bookings, instead of future bookings |
| nextResponse | false | If set, adds a choice to continue the conversation with this Respones |
| nextResponseChoice | false | The title of the choice added if nextResponse is set, defaults to Continue |
| bookingsMessage | false | The message displayed before the gallery of found bookings, defaults to Here are the bookings I could find |
### Creating bookings Using the deep link handler, it is possible to create bookings directly in the chat, at this time this functionality is limited only to members, and activities that has a cost of 0 for that member. This is due to the integration currently not supporting taking payments, or fetching the 3DS challenge necessary for payments. As a side-effect, any bookings created in chat will not be marked as being paid for.