Create a notification definition

Creates a notification definition. If a filter rule is specified, it will be evaluated to see if the notification definition is qualified to handle the incoming events during runtime. If the notification is qualified, it will send the email and invoke the callout if it has an email template or a callout.

This operation supports creating notification definitions for all event types:

You must specify either eventCategory or eventTypeName, but not both at the same time.

Request
header Parameters
Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required

The request body used to create the notification definition.

name
required
string <= 255 characters

The name of the notification definition, unique per communication profile.

active
boolean
Default: true

The status of the notification definition. The default value is true.

associatedAccount
string

The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from. Available values are as follows:

  • Account.Id: ID of the primary customer account related to the notification. It is also the default value.
  • ParentAccount.Id: this option is available only if you have Customer Hierarchy enabled for your tenant.
  • SubscriptionOwnerAccount.Id: this option is available if the base object of the notification is Order Action.

Note: before specifying this field, we recommend that you use Data Source to check the available types of accounts for the current notification.

Callout - without authentication (object) or Callout - Base authentication (object) or Callout - OAuth 2.0 authentication (object)
calloutActive
boolean
Default: false

The status of the callout action. The default value is false.

communicationProfileId
string

The profile that notification definition belongs to.

You can use the Query Action to get the communication profile Id. See the following request sample:

{ "queryString": "select Id, ProfileName from CommunicationProfile" }

If you do not pass the communicationProfileId, notification service will be automatically added to the 'Default Profile'.

description
string <= 255 characters

The description of the notification definition.

emailActive
boolean
Default: false

The status of the email action. The default value is false.

emailTemplateId
string <uuid>

The ID of the email template. If emailActive is true, an email template is required. And EventType of the email template MUST be the same as the eventType.

eventCategory
number

The event category code for a standard event, on which the notification definition is created.

This field is required when creating notification definitions for standard events.

For the list of supported standard event category codes, see Standard event category code for events and notifications.

eventTypeName
string non-empty

The name of the event that the notification definition is based on.

This field is required when creating notification definitions for Zuora custom events, custom events, or custom scheduled events.

If this field is provided, you can specify the event namespace in the eventTypeNamespace field.

eventTypeNamespace
string
Default: "user.notification"

The namespace of the eventTypeName field. It indicates who created the event and which namespace the event is assigned to.

Supported values are as follows:

  • com.zuora.notification: events that are created by Zuora. This value applies to Zuora custom events.
  • user.notification: events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value.

For example, if you want to create a notification definition on the OrderActionProcessed event, which is a Zuora custom event, you must specify com.zuora.notification for this field.

Enum: "user.notification" "com.zuora.notification"
object
object (filterRuleParams)

The parameter values used to configure the filter rule.

Responses
200

OK

400

Bad Request

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

500

Internal Server Error

post/notifications/notification-definitions
Request samples
application/json
{
  • "active": true,
  • "associatedAccount": "ParentAccount.Id",
  • "callout": {
    },
  • "calloutActive": true,
  • "communicationProfileId": "6e569e1e05f040eda51a927b140c0ac5",
  • "description": "Notification sent out when an account is edited",
  • "emailActive": true,
  • "emailTemplateId": "6e569e1e05f040eda51a927b140c0ac6",
  • "eventTypeName": "AccountEdit",
  • "filterRule": {
    },
  • "filterRuleParams": {
    },
  • "name": "Account Edit Notification"
}
Response samples
application/json
{
  • "active": true,
  • "associatedAccount": "ParentAccount.Id",
  • "callout": {
    },
  • "calloutActive": true,
  • "communicationProfileId": "6e569e1e05f040eda51a927b140c0ac5",
  • "createdBy": "6e569e1e05f040eda51a927b140c0ac3",
  • "createdOn": "2017-04-18T07:36:19.798Z",
  • "description": "Notification sent out when an account is edited",
  • "emailActive": true,
  • "emailTemplateId": "6e569e1e05f040eda51a927b140c0ac6",
  • "eventTypeName": "AccountEdit",
  • "filterRule": {
    },
  • "filterRuleParams": {
    },
  • "id": "6e569e1e05f040eda51a927b140c0ac2",
  • "name": "Account Edit Notification",
  • "updatedBy": "6e569e1e05f040eda51a927b140c0ac4",
  • "updatedOn": "2017-04-18T07:36:19.798Z"
}