setNotificationPreferences Specify event notifications

Notifications are configured in three parts:

  • An account-wide on/off switch: applicationDeliveryPreferences.applicationEnable
  • URL setting and URL-specific on/off switches: applicationDeliveryPreferences.deliveryURLDetails
  • Event-specific on/off switches: userDeliveryPreferenceArray.notificationEnable

Take a look at examples in C#, Java, Python, and Ruby.

setNotificationPreferences Input

setNotificationPreferences is a secure API method with the following URL and HTTP header requirements:

Submit to URL:
Required in HTTP header: X-BONANZLE-API-DEV-NAME set to your dev_id
  X-BONANZLE-API-CERT-NAME set to your cert_id

Note that all secure methods except for fetchToken and getBoothItems require you to submit a user token so that we know what user account you are acting on behalf of.  For details about setting up and submitting user tokens, see our intro to user tokens.

The name for your request should be setNotificationPreferencesRequest.

Here are the available input parameters that can be serialized into JSON:

Argument Type Occurrence Meaning
requesterCredentials Container Required Container for user credentials
requesterCredentials .bonanzleAuthToken string Required The verified user token for the user who you are acting on behalf of.
Call-specific Input Fields
applicationDeliveryPreferences Container Required Container to hold all the details about notification being set up.
applicationDeliveryPreferences.applicationEnable string Optional Enables or disables all notifications, preserving but overriding any previously specified notification preferences. Possible values are:
  • Disable: Disables any previously specified notifications.
  • Enable: Enables any previously specified notifications.
applicationDeliveryPreferences.deliveryURLDetails Container Optional  
string Optional The address of a notification delivery URL. For delivery to a server, the URL must begin with http:// or https:// and be well formed.
string Optional Enables or disables this notification URL. Possible values are:
  • Disable: The entry is disabled.
  • Enable: The entry is enabled.
userDeliveryPreferenceArray Container Optional  
Container Optional Array of containers for individual events.
string Optional Enables or disables notifications for this event. Possible values are:
  • Disable: The entry is disabled.
  • Enable: The entry is enabled.
EventNotificationType Optional See list of possible values in EventNotificationType
boolean Optional Whether or not to include detailed information

setNotificationPreferences Output

The name for the output returned from this request is setNotificationPreferencesResponse. So, after parsing the serialized response into JSON, you can access the data with something like my_json_hash['setNotificationPreferencesResponse']

Here are all the possible output parameters:

Argument Type Occurrence Meaning
Standard Output Fields
errorMessage Container Conditionally Description of an error or warning that occurred when Bonanza processed the request. Not returned if the ack value is Success.
errorMessage.error Container Conditionally,
repeatable: [0..*]
errorMessage.error.category ErrorCategory Conditionally Currently unused.
errorMessage.error.message string Conditionally A description of the error
errorMessage.error.type ErrorType Conditionally A unique descriptive name for the error.
timestamp dateTime Always This value represents the date and time when Bonanza processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about this time format and converting to and from the GMT time zone.
warnings Container Conditionally Description of a warning that occurred when Bonanza processed the request.
warnings.unrecognized_parameters Container Conditionally,
repeatable: [0..*]
An array of unrecognized parameters.

setNotificationPreferences Examples