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

  • Input Schema

  • Output Schema

User ID textField required

The unique identifier for the user.

Email textField required

The email address to which notifications are sent.

Notification Name dropDown

The name of a custom notification defined in PingOne. If the form you want is not listed, select Enter Custom Value.

  • Enter Custom Value

Custom Value textField

You can enter a custom template name, or leave blank to use the default template. You can also enter a parameter from a previous connector, or any text.

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.

  • default object

    • properties object

      • userId string minLength: 0 maxLength: 100

      • templateVariant null/string

      • customTemplateVariant null/string/object

      • templateLocale null/string

      • templateVariables array

      • email string

      • sendSync boolean

    Send synchronize notification

  • output object

    • rawResponse object

      • id string

      • environment object

        • id string

      • user object

        • id string

      • policy object

        • id string

      • deliveryMethod string

      • from string

      • subject string

      • body string

      • address string

      • updatedAt string

      • createdAt string

    • headers object

    • statusCode integer

Output Example

 { "rawResponse" :
  { "id" : "00584480-5795-448f-8ade-fcc792c7dbbe",
   "environment" :
   { "id" : "602cc283-b258-444e-acd0-5553330a206c" },
   "user" :
   { "id" : "1528312c-ccff-48ff-be64-3c56d0110aba" },
   "policy" :
   { "id" : "6f5377b1-df6f-4999-9a24-70a7cb534e8e" },
   "deliveryMethod" : "Email",
   "from" : "\"PingOne\" <noreply@pingidentity.com>",
   "subject" : "Custom email notification",
   "body" : "Hi John, Enter your custom message here",
   "address" : "galdalal@pingidentity.com",
   "updatedAt" : "2022-08-01T14:21:50.010Z",
   "createdAt" : "2022-08-01T14:21:49.560Z" } }

Send SMS

Send users customized SMS messages.

Show details

  • Properties

  • Input Schema

  • Output Schema

User ID textField required

The unique identifier for the user.

Phone Number textField required

The phone number to which notifications are sent.

Notification Name dropDown

The name of a custom notification defined in PingOne. If the form you want is not listed, select Enter Custom Value.

  • Enter Custom Value

Custom Value textField

You can enter a custom template name, or leave blank to use the default template. You can also enter a parameter from a previous connector, or any text.

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.

  • default object

    • properties object

      • userId string minLength: 0 maxLength: 100

      • templateVariant null/string

      • customTemplateVariant null/string/object

      • templateLocale null/string

      • templateVariables array

      • phone string

      • sendSync boolean

    Send synchronize notification

  • output object

    • rawResponse object

      • id string

      • environment object

        • id string

      • user object

        • id string

      • policy object

        • id string

      • deliveryMethod string

      • content string

      • phone string

      • sender string

      • updatedAt string

      • createdAt string

    • headers object

    • statusCode integer

Output Example

 { "rawResponse" :
  { "id" : "001b1fc7-a41f-4018-a70e-1c3f7b97a970",
   "environment" :
   { "id" : "602cc283-b258-444e-acd0-5553330a206c" },
   "user" :
   { "id" : "1528312c-ccff-48ff-be64-3c56d0110aba" },
   "policy" :
   { "id" : "6f5377b1-df6f-4999-9a24-70a7cb534e8e" },
   "deliveryMethod" : "SMS",
   "content" : "Enter your custom message here",
   "phone" : "+972547639689",
   "sender" : "+19895464225",
   "updatedAt" : "2022-08-01T14:21:50.010Z",
   "createdAt" : "2022-08-01T14:21:49.560Z" } }

Send Voice Message

Send users customized voice messages..

Show details

  • Properties

  • Input Schema

  • Output Schema

User ID textField required

The unique identifier for the user.

Phone Number textField required

The phone number to which notifications are sent.

Notification Name dropDown

The name of a custom notification defined in PingOne. If the form you want is not listed, select Enter Custom Value.

  • Enter Custom Value

Custom Value textField

You can enter a custom template name, or leave blank to use the default template. You can also enter a parameter from a previous connector, or any text.

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.

  • default object

    • properties object

      • userId string minLength: 0 maxLength: 100

      • templateVariant null/string

      • customTemplateVariant null/string/object

      • templateLocale null/string

      • templateVariables array

      • phone string

      • sendSync boolean

    Send synchronize notification

  • output object

    • rawResponse object

      • id string

      • environment object

        • id string

      • user object

        • id string

      • policy object

        • id string

      • deliveryMethod string

      • content string

      • phone string

      • sender string

      • updatedAt string

      • createdAt string

    • headers object

    • statusCode integer

Output Example

 { "rawResponse" :
  { "id" : "002855e3-f505-4142-91b4-bcc252c5efcb",
   "environment" :
   { "id" : "602cc283-b258-444e-acd0-5553330a206c" },
   "user" :
   { "id" : "1528312c-ccff-48ff-be64-3c56d0110aba" },
   "policy" :
   { "id" : "6f5377b1-df6f-4999-9a24-70a7cb534e8e" },
   "deliveryMethod" : "Voice",
   "content" : "Enter your custom message here",
   "phone" : "+972547639689",
   "sender" : "+12106102319",
   "updatedAt" : "2022-08-01T14:21:50.010Z",
   "createdAt" : "2022-08-01T14:21:49.560Z" } }