Find the answer you are looking for

Node ASE Client

The ASE Client node allows you to create, retrieve, and update client information on the Appointment Scheduling Enterprise (ASE) platform. To use it, go to Studio and look for the ASE Client node within the Appointment Scheduling Enterprise category.

⚙ Node configuration
Below you will find a description of the fields available to configure the node:

1. Name (optional): allows you to customize the node name within the flow, replacing the default value.
2. Credentials (required): allows you to select the credentials for the Engageware Appointment Scheduling Enterprise service. You can save multiple credentials, but only one can be active.
To configure them, you must enter the following information:

  • Instance URL: environment URL.
  • Username: username for API consumption.
  • Password: password corresponding to the API user.

3. Action (required): defines the type of operation the node will perform. You can select the following options:
➡ Search: allows you to retrieve the information of a specific client using the following search criteria:

  • Client External Id (string): external identifier assigned to the client when it was created. Allows you to search for clients whose ID matches the value entered.
  • First Name (string): client first name.
  • Last Name (string): client last name.
  • User Name (string): client username.
  • Email Address (string): client contact email address.
  • ClientExternalId: client identifier in Appointment Scheduling Enterprise. It can be any text string if provided when the client is created. Otherwise, the system will generate one automatically.
  • Phone Number (string): client contact phone number.
  • Exact Match Only (boolean): defines whether the search must exactly match the data entered.
  • Modified Since (dateTime): allows you to filter clients by the date since they were modified.

➡ Create / Update: allows you to create a client or update the information of an existing one.
For these operations, you will find the following fields:

  • ClientExternalId: client identifier in Appointment Scheduling Enterprise. It can be any text string if provided during creation. Otherwise, the system will generate one automatically.
  • Client properties: contains the properties that will be stored when the client is created or updated if the client already exists.

↗ Outputs
The results of each operation will be available in the following properties of the msg object:
1. Create: msg.payload.metadata.EW_ASE_CreateClientResponse ➡ If the creation is successful, the status property will return the value 0.
In case of error, it will return: msg.payload.metadata.EW_ASE_CreateClientResponse.error
2. Get: msg.payload.metadata.EW_ASE_GetClientResponse ➡ If the query is successful, the client information will be returned.
In case of error, it will return: msg.payload.metadata.EW_ASE_GetClientResponse.error
3. Update: msg.payload.metadata.EW_ASE_UpdateClientResponse ➡ If the update is successful, the status property will return the value 0.
In case of error, it will return: msg.payload.metadata.EW_ASE_UpdateClientResponse.error

📥 You can download an example flow at this link.

▶ In the following video, we show you how to configure the node:

This website stores cookies on your computer. These cookies are used to collect information about how you interact with our website and allow us to remember you. We use this information in order to improve and customize your browsing experience and for analytics and metrics about our visitors both on this website and other media. To find out more about the cookies we use, see our Privacy Policy.

If you decline, your information won’t be tracked when you visit this website. A single cookie will be used in your browser to remember your preference not to be tracked.