--- title: "List notification definitions" method: GET path: "/notifications/notification-definitions" tags: ["Notifications"] --- # List notification definitions `GET /notifications/notification-definitions` Queries notification definitions with the specified filters. ## Query parameters - `start` integer - `limit` integer - `profileId` string, uuid - `eventCategory` number - `eventTypeName` string - `emailTemplateId` string, uuid ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string ## Response `200` OK - object - `data` GETPublicNotificationDefinitionResponse[] - `active` boolean — The status of the notification definition. The default value is `true`. - `associatedAccount` string, nullable — The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from. - `callout` object, nullable - `active` boolean — The status of the callout. The default value is `true`. - `calloutAuth` CalloutAuth, nullable — If `requiredAuth` is `true`, this object is required. - `domain` string — The domain of the callout auth. - `password` string — The field is required when `requiredAuth` is `true`. - `preemptive` boolean — Set this field to `true` if you want to enable the preemptive authentication. - `username` string — The field is required when `requiredAuth` is `true`. - `calloutBaseurl` string, url — The callout URL. It must start with 'https://' - `calloutParams` CalloutMergeFields — A key-value map of merge fields of this callout. - `calloutRetry` boolean — Specified whether to retry the callout when the callout fails. The default value is `true`. - `description` string — Description for the callout. - `eventTypeName` string — The name of the custom event type. - `httpMethod` 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' — The HTTP method of the callout. - `id` string, uuid — The ID of the callout. If `calloutActive` is `true`, a callout is required. The eventTypeName of the callout MUST be the same as the eventTypeName. - `name` string — The name of the created callout. - `oauth2ProviderId` string — The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. - `requiredAuth` boolean — Indicates whether Basic authentication is enabled for the callout. - `requiredOauth2` boolean — Indicates whether OAuth 2.0 authentication is enabled for the callout. - `calloutActive` boolean — The status of the callout action. The default value is `false`. - `calloutTemplateIds` string[] — List of callout template IDs that the notification definition is associated with. - `communicationProfileId` string, uuid — The ID of the communication profile that the notification definition is associated with. If the notification definition is associated with multiple communication profiles, see `communicationProfileIds` for all associated communication profile IDs. - `communicationProfileIds` string[] — List of communication profile IDs that the notification definition is associated with. - `createdBy` string, uuid — The ID of the user who created the notification definition. - `createdOn` string — The time when the notification definition was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00 - `description` string, nullable — Description of the notification definition - `emailActive` boolean — The status of the email action. The default value is `false`. - `emailTemplateId` string, uuid — The ID of the email template. In the request, there should be at least one email template or callout. - `eventCategory` number — The event category code for a standard event, on which the notification definition is created. This field is available only if the notification definition is based on a standard event. For the list of supported standard event category codes, see Standard event category code for events and notifications. - `eventId` string, uuid — The ID of the event that the notification definition is based on. This field is available only if the notification definition is based on a standard event. - `eventTypeName` string — The name of the event that the notification definition is based on. This field is available only if the notification definition is based on a Zuora custom event, custom event, or custom scheduled event. - `eventTypeNamespace` 'user.notification' | 'com.zuora.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 field is available only if the notification definition is based on a Zuora custom event, custom event, or custom scheduled event. - `filterRule` object - `condition` string — The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-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](https://docs.zuora.com?resourceId=platform-data-source-reference). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the `Invoice` object: ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0``` There are conventions and keywords you need to be aware of. For example: * `changeType` is a keyword to specify what kind of change happened to the object. Allowed values are `INSERT`, `UPDATE` or `DELETE`. * `Invoice.Status` refers to field `Status` of the Zuora object `Invoice`. * A variable with the `_old` suffix means it’s a previous value of the corresponding object field. The "_old" fields are only available on the base objects. - `description` string — The description of the filter rule. - `eventTypeName` string — The value is `null`. - `id` string, uuid — The ID of the filter rule. If not specified or null, the notification definition is always qualified to process events of "eventType". - `parameters` FilterRuleParameterDefinitions — 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` - `filterRuleParams` FilterRuleParameterValues — The parameter values used to configure the filter rule. - `id` string, uuid — The ID associated with this notification definition. - `name` string — The name of the notification definition. - `updatedBy` string, uuid — The ID of the user who updated the notification definition. - `updatedOn` string — The time when the notification was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00 - `next` string — The URI to query the next page of data, e.g. '/notification-definitions?start=1&limit=10'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null. ## Other responses - `404` — Not Found - `405` — Method Not Allowed - `415` — Unsupported Media Type - `500` — Internal Server Error --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)