List notification definitions

Queries notification definitions with the specified filters.

Request

query Parameters

start	integer <int32> Default: 1 The first index of the query result.
limit	integer <int32> [ 1 .. 100 ] Default: 20 The maximum number of results the query should return.
profileId	string <uuid> Id of the profile.
eventCategory	number 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 Standard event category code for events and notifications. You cannot specify `eventCategory` and `eventTypeName` at the same time.
eventTypeName	string 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.
emailTemplateId	string <uuid> The ID of the email template.

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

Responses

200

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

500

Internal Server Error

get/notifications/notification-definitions

Request samples

cURL

Response samples

application/json

{"data": [{"active": true,
"associatedAccount": "ParentAccount.Id",
"callout": {"active": true,
"calloutAuth": {"domain": "example_domain",
"password": "example_password",
"preemptive": true,
"username": "example_user"
},
"calloutBaseurl": "https://www.example.com/callout/AccountEdit",
"calloutParams": {"AccountName": "<Account.Name>",
"AccountNumber": "<Account.AccountNumber>"
},
"calloutRetry": true,
"description": "Callout when an account is edited",
"eventTypeName": "AccountEdit",
"httpMethod": "POST",
"id": "6e569e1e05f040eda51a927b140c0ac7",
"name": "Callout for Account Edited",
"requiredAuth": true
},
"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": {"condition": "Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS",
"description": "Filter rule to test if an account is a VIP account",
"eventTypeName": null,
"id": "6e569e1e05f040eda51a927b140c0ac8",
"parameters": {"_ACCOUNT_STATUS": {"description": "The status of the VIP Account",
"displayName": "VIP Account Status",
"options": ["Draft",
"Active",
"Canceled"
],
"valueType": "STRING"
},
"_VIP_BALANCE_AMOUNT": {"description": "The minimum account balance",
"displayName": "VIP Account Balance",
"options": null,
"valueType": "BIG_DECIMAL"
}
}
},
"filterRuleParams": {"_ACCOUNT_STATUS": "Active",
"_VIP_BALANCE_AMOUNT": "100000"
},
"id": "6e569e1e05f040eda51a927b140c0ac2",
"name": "Account Edit Notification",
"updatedBy": "6e569e1e05f040eda51a927b140c0ac4",
"updatedOn": "2017-04-18T07:36:19.798Z"
}
],
"next": "/notification-definitions?start=1&limit=10"
}