Auth node reference

Polling Wait node

The Polling Wait node pauses the journey for a specified number of seconds. For example, to wait for a response to a one-time passcode email or push notification, or wait for a response from an external system.

The end user UI automatically waits for the required amount of time and resubmits the page to continue evaluation. During the wait period, a configurable message is shown to the user to keep them informed.

Requests made during the wait period are sent a PollingWaitCallback and an authentication ID. For example, the following callback indicates a wait period of 10 seconds:

{
    "authId": "eyJ0eXAiOiJK...u4WvZmiI",
    "callbacks": [
        {
            "type": "PollingWaitCallback",
            "output": [
                {
                    "name": "waitTime",
                    "value": "10000"
                },
                {
                    "name": "message",
                    "value": "Waiting for response..."
                }
            ]
        }
    ]
}

The client must wait 10 seconds before returning the callback data, including the authId:

$ curl \
--request POST \
--header "Accept-API-Version: resource=2.0, protocol=1.0" \
--header "Content-Type: application/json" \
--data '{
  "authId": "eyJ0eXAiOiJK…​u4WvZmiI",
  "callbacks": [
      {
          "type": "PollingWaitCallback",
          "output": [
              {
                  "name": "waitTime",
                  "value": "10000"
              },
              {
                  "name": "message",
                  "value": "Waiting for response…​"
              }
          ]
      }
  ]
}' \
'https://am.example.com:8443/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Example'

Find more information in the documentation on this callback for:

Example

The following example journeys include this node:

Availability

Product Available?

PingOne Advanced Identity Cloud

Yes

PingAM (self-managed)

Yes

Ping Identity Platform (self-managed)

Yes

Inputs

None. This node doesn’t read shared state data.

Dependencies

None.

Configuration

Property Usage

Seconds To Wait

The number of seconds to pause the journey.

Default: 8

Enable Spam Detection

Select this option to track the number of requests received during the wait period.

If the number of requests exceed the number specified in the Spam Tolerance property, the journey proceeds to the Spam outcome.

Default: Disabled

Spam Tolerance

The number of requests to allow during the wait period. If this number is exceeded, the journey proceeds to the Spam outcome.

This property only applies if the Enable Spam Detection option is selected.

Default: 3

Waiting Message

(Optional) Add a custom, localized message to display to the user while they’re waiting.

Add instructions

  1. Click .

  2. In the Key field, enter the locale. For example, en-gb.(1)

  3. In the Value field, enter the message.

  4. Click Done.

  5. Repeat to add more messages and save your changes when you’re done.

Leave blank to use the default message.(2)

Exitable

Select this option if the user can exit the node during the wait period.

When enabled, a Cancel button is displayed to the user to let them exit the node before the waiting period has elapsed.

If the user clicks this button, the journey proceeds to the Exit outcome.

Default: Disabled

Exit Message

(Optional) Add custom, localized text to display on the Cancel button.

For example, Lost phone? Use Recovery Code.

Add instructions

  1. Click .

  2. In the Key field, enter the locale. For example, en-gb.(1)

  3. In the Value field, enter the message.

  4. Click Done.

  5. Repeat to add more messages and save your changes when you’re done.

Leave blank to use the default message.(2)

This property only applies if the Exitable option is selected.

(1) Specify a locale that Java supports, such as en-gb. Otherwise, the node throws a configuration exception with an Invalid locale provided message.

(2) PingAM only: Learn more about customizing and translating default messages in Internationalize nodes.

Outputs

This node doesn’t change the shared state.

Outcomes

Done

A request is received after the wait period has elapsed.

Exited

The user clicked the Cancel button to exit the node.

This outcome is only available if the Exitable option is selected.

Spam

The number of requests received exceeds the number specified in the Spam Tolerance property.

This outcome is only available if the Enable Spam Detection option is selected.

Errors

This node doesn’t log any error or warning messages of its own.