Pricing Templates
Log in Sign up
Integrations / Zuora / ...

POST /notifications/notification-definitions

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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"
Content-Encoding String No

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 No

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 (').
Authorization String Yes

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 No

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.
Zuora-Entity-Ids String No

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 No

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.
Accept-Encoding String No

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.

Request body fields

Name Type Required Description
filterRuleParams Object No

The parameter values used to configure the filter rule.
calloutActive Boolean No

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

Default value: false
description String No

The description of the notification definition.
filterRule Object No
filterRule.description String No

The description of the filter rule.
filterRule.parameters Object Yes

The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: AttachmentList, RecipientList, RecipientType, Exceptions, OCP_OBJECT_TYPE, OCP_OBJECT_ID, OCP_TRIGGER_BY
filterRule.parameters.name Object No

Definition of a filter rule parameter.
filterRule.parameters.name.description String No
filterRule.parameters.name.options[] Array No

The option values of the parameter.
filterRule.parameters.name.displayName String No

The display name of the parameter.
filterRule.parameters.name.valueType String No

The type of the value.

Possible values:

  • "CHARACTER_ARRAY"
  • "STRING"
  • "BOOLEAN_ARRAY"
  • "LOCAL_DATE_TIME"
  • "INTEGER"
  • "LOCAL_DATE"
  • "TIMESTAMP_ARRAY"
  • "FLOAT"
  • "LOCAL_DATE_ARRAY"
  • "LONG"
  • "CHARACTER"
  • "INTEGER_ARRAY"
  • "FLOAT_ARRAY"
  • "SHORT_ARRAY"
  • "DOUBLE"
  • "BYTE"
  • "BIG_INTEGER"
  • "TIMESTAMP"
  • "STRING_ARRAY"
  • "BIG_DECIMAL_ARRAY"
  • "DOUBLE_ARRAY"
  • "BOOLEAN"
  • "LOCAL_DATE_TIME_ARRAY"
  • "BIG_INTEGER_ARRAY"
  • "SHORT"
  • "BIG_DECIMAL"
  • "BYTE_ARRAY"
filterRule.condition String Yes

The filter rule conditions, written in JEXL. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from the base object of the event or from the joined objects of the base object. Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to filter an invoice posted notification to only invoices with an amount over 1000, you would define the following condition:

Invoice.Amount > 1000

There are conventions and keywords you need to be aware of. For example:

  • Invoice.Amount refers to the Amount field of the Zuora object Invoice.

  • Unlike Event Triggers, there is no access to variables with the _old suffix. Fields with the _old suffix are only available on Event Trigger conditions.
emailActive Boolean No

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

Default value: false
associatedAccount String No

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.
emailTemplateId String No

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 No

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 No

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.
name String Yes

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

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

Default value: true
communicationProfileId String No

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'.
callout No
eventTypeNamespace String No

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.

Possible values:

  • "user.notification"
  • "com.zuora.notification"

Default value: "user.notification"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy