Connectors

PingOne Notifications Connector

The PingOne Notifications connector enables you to send custom voice, SMS, and email notifications to cover a wide range of use cases for your customers.

You can create a custom General notifications template in PingOne and reference it in the Notifications connector. For help, see Notification templates.

To add notifications for multi-factor authentication (MFA) use cases, such as push notifications for pairing and authentication within an MFA flow, use the PingOne MFA connector.

Setup

Resources

For information and setup help, see the following:

Requirements

To use the PingOne Notifications connector, you must configure a PingOne environment and create the relevant users.

Setting up the connector

Add the connector in DaVinci as shown in Adding a connector, then configure it as follows.

Connector configuration

Environment ID

Your PingOne Environment ID. In PingOne, go to Settings → Environment Properties.

Notification Policy ID

(Optional) The unique identifier of the PingOne notification policy. You can define a notification policy and reference it as part of the connector setup. For more information, see Notification policies.

If a Notification Policy ID is not specified, the default policy is used. In PingOne, go to User Experience → Notification Policies and in the Notification Policies list, select the Policy ID for the policy you want to use.

Client ID

The Client ID of your PingOne Worker application. In PingOne, go to Applications → Applications → (Your Application) → Configuration. Expand the General section.

Client Secret

The Client Secret of your PingOne Worker application. In PingOne, go to Applications → Applications → (Your Application) → Configuration. Expand the General section and then click the button to reveal the client secret.

Region

Your PingOne environment region. In PingOne, see Settings → Environment Properties.

Using the connector in a flow

You can use the PingOne Notifications connector to add custom voice, SMS, or email notifications in a flow. The PingOne Notifications connector uses the configurations defined in PingOne, including any customer sender configurations, if defined. You can also specify a PingOne notification policy to apply to the connector.

The PingOne Notifications connector is usually added to an existing flow at the point that you want a notification to be sent.

Capabilities

Send Email

Send users customized email messages.

Show details

Properties

User ID textField required

The unique identifier for the user.

Email textField required

The email address to which notifications are sent.

Notification Name textField

The name of a custom notification defined in PingOne. To use the default template, leave this field blank.

Notification Locale textField

Add a locale to allow localized notifications for end-users. ISO Language Codes are supported.

Notification Variables variableInputList

If custom variables are defined in the notification body, map them here.

Wait For Vendor Response toggleSwitch

Indicates whether the connector should wait for the notification vendor to respond to the message request.

Input Schema

default object
userId string minLength: 0 maxLength: 100
templateVariant null/string
templateLocale null/string
templateVariables array
items array
type object
properties
email string
sendSync boolean

Send synchronize notification

Output Schema

output object
rawResponse object
properties object
id string
environment object
properties object
id string
user object
properties object
id string
policy object
properties object
id string
deliveryMethod string
from string
subject string
body string
address string
updatedAt string
createdAt string
headers object
statusCode integer

Send SMS

Send users customized SMS messages.

Show details

Properties

User ID textField required

The unique identifier for the user.

Phone Number textField required

The phone number to which notifications are sent.

Notification Name textField

The name of a custom notification defined in PingOne. To use the default template, leave this field blank.

Notification Locale textField

Add a locale to allow localized notifications for end-users. ISO Language Codes are supported.

Notification Variables variableInputList

If custom variables are defined in the notification body, map them here.

Wait For Vendor Response toggleSwitch

Indicates whether the connector should wait for the notification vendor to respond to the message request.

Input Schema

default object
userId string minLength: 0 maxLength: 100
templateVariant null/string
templateLocale null/string
templateVariables array
items array
type object
properties
phone string
sendSync boolean

Send synchronize notification

Output Schema

output object
rawResponse object
properties object
id string
environment object
properties object
id string
user object
properties object
id string
policy object
properties object
id string
deliveryMethod string
content string
phone string
sender string
updatedAt string
createdAt string
headers object
statusCode integer

Send Voice Message

Send users customized voice messages..

Show details

Properties

User ID textField required

The unique identifier for the user.

Phone Number textField required

The phone number to which notifications are sent.

Notification Name textField

The name of a custom notification defined in PingOne. To use the default template, leave this field blank.

Notification Locale textField

Add a locale to allow localized notifications for end-users. ISO Language Codes are supported.

Notification Variables variableInputList

If custom variables are defined in the notification body, map them here.

Wait For Vendor Response toggleSwitch

Indicates whether the connector should wait for the notification vendor to respond to the message request.

Input Schema

default object
userId string minLength: 0 maxLength: 100
templateVariant null/string
templateLocale null/string
templateVariables array
items array
type object
properties
phone string
sendSync boolean

Send synchronize notification

Output Schema

output object
rawResponse object
properties object
id string
environment object
properties object
id string
user object
properties object
id string
policy object
properties object
id string
deliveryMethod string
content string
phone string
sender string
updatedAt string
createdAt string
headers object
statusCode integer