Sign in
Notifications

List notification definitions

Queries notification definitions with the specified filters.

get/notifications/notification-definitions

Query parameters

startinteger

The first index of the query result.

limitinteger

The maximum number of results the query should return.

profileIdstring uuid

Id of the profile.

eventCategorynumber

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

For the list of supported standard event category codes, see <a href="https://docs.zuora.com?resourceId=platform-parent-and-event-category-code" target="_blank">Standard event category code for events and notifications</a>.

You cannot specify eventCategory and eventTypeName at the same time.

eventTypeNamestring

The name of the Zuora custom event, custom event, or custom scheduled event on which the notification definition is created.

You cannot specify eventCategory and eventTypeName at the same time.

emailTemplateIdstring uuid

The ID of the email template.

Headers

Accept-Encodingstring

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-Encodingstring

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-Idstring

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-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Response

OK

nextstring

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.

Example response

{
  "data": [
    {
      "id": "838bfafa9b224408809f8ecbdae198ef",
      "createdBy": "8ad084a67f9c7138017fab8a8b511b5a",
      "createdOn": "2024-11-11T03:00:03.000 UTC",
      "updatedBy": "8ad084a67f9c7138017fab8a8b511b5a",
      "updatedOn": "2024-11-11T03:00:03.000 UTC",
      "eventTypeNamespace": "user.notification",
      "eventTypeName": "AccountEdit",
      "name": "Account Edit Notification",
      "description": null,
      "communicationProfileId": "2c92c0f9446cd49501447539d6a72815",
      "communicationProfileIds": [
        "2c92c0f9446cd49501447539d6a72815"
      ],
      "active": true,
      "emailTemplateId": "f11e498862584a10a05b83ea70119659",
      "callout": null,
      "calloutTemplateIds": [],
      "filterRule": {
        "id": "a1efc8cc717e48208b9f0fd5d7bf2a58",
        "createdBy": "8ad084a67f9c7138017fab8a8b511b5a",
        "createdOn": "2024-11-11T03:00:04.000 UTC",
        "updatedBy": null,
        "updatedOn": null,
        "description": "Filter rule to test if an account is a VIP account",
        "condition": "Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS",
        "parameters": {
          "_ACCOUNT_STATUS": {
            "displayName": "VIP Account Status",
            "description": "The status of the VIP Account",
            "options": [
              "Draft",
              "Active",
              "Canceled"
            ],
            "valueType": "STRING"
          },
          "_VIP_BALANCE_AMOUNT": {
            "displayName": "VIP Account Balance",
            "description": "The minimum account balance",
            "options": null,
            "valueType": "BIG_DECIMAL"
          }
        },
        "scheduled": false
      },
      "filterRuleParams": {
        "_ACCOUNT_STATUS": "Active",
        "_VIP_BALANCE_AMOUNT": "100000.0"
      },
      "emailActive": true,
      "calloutActive": false,
      "associatedAccount": null
    }
  ],
  "next": "/notification-definitions?start=1&limit=10"
}

Changes