Five9 Web Services Automation

Use the Five9 WFA node to connect directly to Five9 Web Services Automation.

Name

Give the node a name.

Authentication Profile

Select the Studio authentication profile to use.

For more information, see Authentication Profiles.

Webhook

Depending on the authentication profile selected, you may see the option to enter a webhook URL.

Enter a Webhook URL to post transcription information to an external service such as a CMS (content management system).

Additional Options

Supply additional query parameters in the webhook URL if you are calling an action.

Type

Description

Wait for Action Output

When selected, Web Services Automation waits until the action output is generated and then returns that data in the response of the webhook call.

When not selected (default), the webhook executes asynchronously and only returns a success or failure response.

Wrap Output in Value Object

When selected, Studio may at times wrap output in a "value object." Studio does this because an action can specify output of any type and Studio cannot handle polymorphism.

When not selected (default), Studio never wraps output in a "value object." This is probably the most preferred method of

calling a webhook that is waiting for return data.
Note:

Event webhooks do not support calling an action.

Reaction ID and Data Fields

Depending on the authentication profile selected, you may see the option to enter a reaction ID and data fields.

This information is sent to Five9 Web Services Automation.

Enter the reaction ID as text or a variable.

Under Data Fields, supply key-value pairs. Use the test key-value pair fields to test the call flow with Preview Response.

Music on Hold

The caller hears the uploaded audio file while they are placed on hold. Click to upload a WAV file (maximum 3MB).

Fetch Timeout

The fetch timeout is the maximum time in seconds that Studio waits to retrieve data from the API request.

Response

Match JSON name-value pairs of interest.

  1. Click Preview Response to see the JSON name-value pairs.

    Alternatively, to enter JSON directly, click the pencil icon. The pencil turns into a tick. Using the simple editor, ensure your code is valid. Click the tick icon to return to preview mode to continue with these steps.

  2. Select a JSON name-value pair.

    The path to the selected name-value pair is displayed in the JSON Path field.

    You may need to switch between Data and Meta to locate a specific name-value pair.

  3. To edit the JSON path, select Editable JSON.

    Following are some ways to use the editable JSON facility. For more information, see Editable JSON.

    Example

    Description
    response['0']['email'] The path refers to the first email record.
    response['*']['email'] Replace the number zero with an asterisk to refer to all the email records.
    response['{{index}}']['email'] Replace the number zero with a variable to iterate over all the email records.

  4. Give a name to the JSON name-value pair in the Assign path to variable field.

  5. In the Default Value (optional) field, assign a default value to the variable.

    The default value itself can be a variable. Type two curly brackets {{ and select from the available options.

  6. Click Assign.

    The JSON path and variable are added to the table of return values.

  7. Repeat. Select another JSON name-value pair.

You can update the table of return values at any time by assigning different variables to the JSON name-value pairs and changing the default values.