PingOne Platform APIs

Notifications Settings

The notifications settings endpoints provide the ability to configure specific notifications settings for each environment. They implement operations to read, update and reset the settings for the environment.

You need the Environment Admin role to perform operations on notifications settings resources.

Configure an SMS/Voice provider fallback chain

The sequence of SMS/Voice providers in smsProvidersFallbackChain comprises the notification fallback sequence, in the event of a primary or subsequent provider failing to send the notification.

  1. The providers must be configured in the Phone Delivery Settings resource.

  2. Update the notifications setting resource by using the PUT {{apiPath}}/environments/{{envID}}/notificationsSettings/ operation. For example, to define your own provider (represented here as TwilioPhoneDeliverySettingsId) as the primary provider, and Ping’s Twilio account as the fallback:

    {
 "smsProvidersFallbackChain": [ "TwilioPhoneDeliverySettingsId", "PINGONE_TWILIO" ]
}

Notifications settings properties

Property Type Required? Mutable? Description

emailProviderFallbackChain

Array

Optional

Mutable

For email notifications, you can use the Ping server or a customer server/provider that you have defined. If you defined a custom server/provider and want to switch to the Ping server, send an update request and include the emailProviderFallbackChain array with the single value PINGONE_EMAIL. To switch back to your custom server/provider, send an update request and include emailProviderFallbackChain as an empty array.

environment.id

String

Required

Immutable

The environment resource’s unique identifier.

from.name

String

Optional

Mutable

The email’s "from" name.
Refer to Note for details.

from.address

String

Optional

Mutable

The email’s "from" address. This value must be a trusted email address.
Refer to Note for details.

replyTo.name

String

Optional

Mutable

The email’s "reply to" name.
Refer to Note for details.

replyTo.address

String

Optional

Mutable

The email’s "reply to" address. This value must be a trusted email address.
Refer to Note for details.

smsProvidersFallbackChain

Array

Optional

Mutable

A comma-separated list that represents the execution order of different SMS/Voice providers configured for the environment. The providers and their accounts' configurations are represented in the list by the ID of the corresponding PhoneDeliverySettings resource. The only provider which is not represented by a PhoneDeliverySettingsId is the PingOne Twilio provider. The PingOne Twilio provider is represented by the "PINGONE_TWILIO" string. If the smsProvidersFallbackChain list is empty, an SMS or voice message will be sent using the default Ping Twilio account. Otherwise, an SMS or voice message will be sent using the first provider in the list. If the server fails to queue the message using that provider, it will use the next provider in the list to try to send the message. This process will go on until there are no more providers in the list. If the server failed to send the message using all providers, the notification status is set to FAILED.

updatedAt

Date

N/A

Read-Only

The time the resource was last updated.

  • If the environment is configured to use the Ping Identity email sender, only trusted email addresses can be used for from.address and replyTo.address.

  • If the from or replyTo settings are not defined in the content or in notificationsSettings, PingOne uses the default from.name (PingOne) and from.address (noreply@pingidentity.com), and replyTo.name and replyTo.address are not populated.

  • When switching the configuration from a custom email sender to to use the Ping Identity email sender, any untrusted email address that is configured for existing contents is ignored and PingOne uses the trusted address that’s defined in notificationsSettings.

Notifications settings events generated

Refer to Audit Reporting Events for the events generated.

Notifications settings response codes

Code Message

200

Successful operation.

201

Successfully created.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.