Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Notification History > Get Callout Notification Histories

Get Callout Notification Histories

This REST API reference describes how to get a notification history for callouts.

See Notifications and Callouts and Create and Edit Notifications for more information.

Request

  • Production: GET https://api.zuora.com/rest/v1/notification-history/callout
  • API Sandbox: GET https://apisandbox-api.zuora.com/rest/v1/notification-history/callout

Request Header

The accept request header is optional. Only JSON will be returned.

Request Parameters

The maximum date range (endTime - startTime) is three days.

endTime

optional

query

The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. 

startTime

optional

query

The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss.

objectId

optional

query

The ID of an object that triggered a callout notification.

failedOnly

optional

query

If true, only return failed records. If false, return all records in the given date range.

The default value is true.

eventCategory

optional

query

Category of records to be returned by event category.

pageSize

optional

query

Number of rows to return.  Maximum is 40; default is 20.

 

Response

calloutHistories

 A container for callout histories

responseCode

The responseCode of the request.

requestUrl

The base url set in notifications settings.

requestMethod

The request method set in notifications settings.

eventCategory

The event category for the callout.

notification

The name of the notification.

attemptedNum

The number of times the callout was retried.

createTime

The time that the calloutHistory record was made.

eventContext

The context of the callout event.

nextPage

URL for requesting the next page of the response if a next page exists. Absent if there are no more pages.

success

Contains true if successful, otherwise false.

processId

Internal process ID to assist Zuora support. Only returned if success is false.

reasons

Information on one or more reasons for the result. Only returned if success is false.

code

Eight-digit numeric error code

message

Description of the error

Examples

HTTP/JSON request:

GET https://api.zuora.com/rest/v1/notification-history/callout?startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000&pageSize=1

 

JSON response:

​{
   "calloutHistories": [
       {
           "responseCode": 405,
           "requestUrl": "https://www.google.com",
           "requestMethod": "POST",
           "eventCategory": 1210,
           "notification": "New Subscription Created",
           "attemptedNum": 3,
           "createTime": "2015-01-13T03:33:51",
           "eventContext": {
               "<Account.Currency>": "USD",
               "<Subscription.SubscriptionDetailTable>": "
               Charge Name:recurringcharge
               Charge Type:Recurring
               Effective Start Date:01/01/2016
               Unit Price:50.00
               QTY:5.00
               Total:250.00",
               "<Account.CurrencySymbol>": "$",
               "<BillToContact.FirstName>": "Mary",
               "<Subscription.ServiceActivation>": "01/01/2016",
               "<Subscription.InitialTerm>": "50",
               "<Subscription.RenewalTerm>": "0",
               "<Subscription.CustomerAcceptance>": "01/01/2016",
               "<Account.Name>": "test",
               "<Subscription.SubscriptionName>": "A-S00000003",
               "<Account.ID>": "402881e54ade80c8014ade884c48000b",
               "<BillToContact.WorkEmail>": "test@test.test",
               "<Account.Number>": "A00000001",
               "<Subscription.TermStartDate>": "01/01/2016",
               "<Event.Timestamp>": "2015-01-13T22:31:43.248+0800",
               "<Subscription.AutoRenew>": "No",
               "<Notification>": {
                   "id": "402892fa47866fe701478674a5c100eb",
                   "EmailTemplate": "New Subscription Created Default Email Template",
                   "Event": "New Subscription Created",
                   "Profile": "Default Profile",
                   "emailAction": true,
                   "calloutAction": true,
                   "updatedOn": "01/12/2015 03:23:08",
                   "updatedBy": "402892fa47866fe7014786749d9b0002"
               },
               "<BillToContact.LastName>": "Smith",
               "<Object.ID>": "402881e54ae37f31014ae3b514e100fd",
               "<Subscription.ContractEffective>": "01/01/2016",
               "<Subscription.TCV>": "$12,500.00",
               "<Contact.ID>": "402881e54ade80c8014ade884c51000c",
               "<Subscription.CMRR>": "$250.00",
               "<BillToContact.ID>": "402881e54ade80c8014ade884c51000c",
               "<Event.Category>": "SubscriptionCreated",
               "<Subscription.TermSetting>": "termed",
               "<BillingAccount.ID>": "402881e54ade80c8014ade884c48000b",
               "<Subscription.CreateDate>": "01/13/2015",
               "<Subscription.TermEndDate>": "03/01/2020",
               "<Subscription.ID>": "402881e54ae37f31014ae3b514e100fd",
               "<Event.ID>": "402892fa47866fe701478674a4ff0093",
               "<Subscription.CreatedBy>": "da@da.com"
           }
       }
   ],
   "nextPage": "https://localhost:8080/apps/v1/notification-history/callout?page=2&pageSize=1&startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000",
   "success": true
}
Last modified
09:31, 11 Aug 2016

Tags

Classifications

(not set)