Event Responses
When a subscribed event is triggered in Responsys. Responsys will call your callback URL. The payloads Responsys will send for each event type are outlined below.
Email Bounced
{
"campaignId": "193897761",
"riid": "3738409741",
"failureReason": "MAILBOX_FULL",
"customerId": "10",
"recipient": "example@oracle.com",
"failureType": "EMAIL_BOUNCED",
"channelType": "Email",
"campaignName": "Summer Promotions"
},
{
"campaignId": "193897761",
"riid": "3738409741",
"failureReason": "USER_NOT_FOUND",
"recipient": "example@oracle.com",
"failureType": "EMAIL_BOUNCED",
"channelType": "Email",
"campaignName": "Summer Promotions"
}
Email Clicked
{
"campaignId": "194527041",
"riid": "3780835341",
"customerId": "123",
"failureType": "EMAIL_CLICKED",
"channelType": "Email",
"campaignName": "Summer_Campaign",
"optionalData": {
"props": {
"prop": {
"name": "EMAIL_ADDRESS_",
"value": "john.doe@oracle.com"
}
}
}
}
Email Complaint
{
"campaignId": "76686941",
"riid": "95628461",
"customerId": "1141676",
"failureType": "EMAIL_COMPLAINT",
"channelType": "Email",
"campaignName": "Summer Campaign",
"optionalData": null
}
Email Failed
{
"campaignId": "193897821",
"riid": "3738409721",
"failureReason": "Failing Reason",
"recipient": "example@oracle.com",
"failureType": "EMAIL_FAILED",
"channelType": "Email",
"campaignName": "Summer Promotions",
"optionalData": {
"props": {
"prop": [
{
"name": "CUSTOM_COLUMN1",
"value": "John 1"
},
{
"name": "EMAIL_ADDRESS_",
"value": "example@oracle.com"
}
]
}
}
}
Email Opt In
{
"riid": "25667",
"customerId": "100AB",
"failureType": "EMAIL_OPTIN",
"channelType": "Email",
"optionalData": null
}
Email Opt Out
{
"riid": "25667",
"customerId": "100AB",
"failureType": "EMAIL_OPTOUT",
"channelType": "Email",
"optionalData": null
}
Email Skipped
{
"campaignId": "193897761",
"riid": "3738409721",
"failureReason": "Expression resulted in an empty value",
"recipient": "oracle@example.com",
"failureType": "EMAIL_SKIPPED",
"channelType": "Email",
"campaignName": "Summer Promotions",
"optionalData": {
"props": {
"prop": [
{
"name": "CUSTOM_COLUMN1",
"value": "John"
},
{
"name": "EMAIL_ADDRESS_",
"value": "oracle@example.com"
}
]
}
}
}
MMS Failed
{
"campaignId": "193898101",
"riid": "3658253801",
"failureReason": "failing",
"recipient": "US - 16502229405",
"failureType": "MMS_FAILED",
"channelType": "Mms",
"campaignName": "Summer Promotions"
}
MMS Skipped
{
"campaignId": "193898281",
"riid": "3658253801",
"failureReason": "Error personalizing field: EXAMPLE.CUSTOMER_ID_: empty field value;",
"recipient": "US - 16502229405",
"failureType": "MMS_SKIPPED",
"channelType": "Mms",
"campaignName": "Summer Promotions"
}
Push Bounced
{
"campaignId": "193558821",
"riid": "3721112141",
"failureReason": "InvalidParameters",
"failureType": "PUSH_BOUNCED",
"channelType": "Push",
"campaignName": "Summer Promotions"
}
Push Failed
{
"campaignId": "193293541",
"riid": "3732406721",
"failureReason": "Message Expiry time has passed. Message Expiry time must be sometime in the future.",
"failureType": "PUSH_FAILED",
"channelType": "Push",
"campaignName": "Summer Promotions"
}
Push Opt In
{
"riid": "138435587",
"customerId": null,
"failureType": "PUSH_OPT_IN",
"channelType": "Push",
"optionalData": null
}
Push Opt Out
{
"riid": "138435587",
"customerId": null,
"failureType": "PUSH_OPT_OUT",
"channelType": "Push",
"optionalData": null
}
Push Skipped
{
"campaignId": "193561021",
"riid": "3728082761",
"failureReason": "Error personalizing field: NEW_PUSH_LIST_APP.ADVERTISER_ID_: empty field value;",
"failureType": "PUSH_SKIPPED",
"channelType": "Push",
"campaignName": "Summer Promotions"
}
SMS Failed
{
"campaignId": "193897941",
"riid": "3658253801",
"failureReason": "failing",
"recipient": "US - 16502229405",
"failureType": "SMS_FAILED",
"channelType": "Sms",
"campaignName": "SMS_Fail",
"optionalData": {
"props": {
"prop": [
{
"name": "CUSTOM_COLUMN1",
"value": "CUSTOM_COLUMN1"
},
{
"name": "MOBILE_NUMBER_",
"value": "16502229405"
}
]
}
}
}
{
"campaignId": "883221",
"riid": "3558989401",
"failureReason": "java.lang.NullPointerException",
"recipient": "-1 - -1",
"failureType": "SMS_FAILED",
"channelType": "Sms",
"campaignName": "Summer Promotions"
}
SMS MO FW
{
"campaignId": "218604367",
"riid": "287229527",
"recipient": "US - 16502882154",
"failureType": "SMS_MO_FW_FAILED",
"channelType": "Sms",
"campaignName": "SMS_MO_FW"
}
SMS Opt In
{
"campaignId": "0",
"riid": "2774307",
"customerId": "CUST_2774307",
"failureType": "SMS_OPT_IN",
"channelType": "Sms",
"campaignName": "N/A",
"optionalData": null
}
SMS Opt Out
{
"campaignId": "0",
"riid": "2774307",
"customerId": "CUST_2774307",
"failureType": "SMS_OPT_OUT",
"channelType": "Sms",
"campaignName": "N/A",
"optionalData": null
}
SMS Receipt
{
"campaignId": "15648030",
"riid": "29074598",
"customerId": null,
"failureType": "SMS_DELIVERY_RECEIPT",
"channelType": "Sms",
"campaignName": "Summer Promotions",
"optionalData": null
}
SMS Skipped
{
"campaignId": "193897881",
"riid": "3738409701",
"failureReason": "Skipped Record - skipped because the country associated with this record is not served by the Short/Long code used in this campaign.;",
"recipient": "IN - 919632155746",
"failureType": "SMS_SKIPPED",
"channelType": "Sms",
"campaignName": "SMS_SKipped",
"optionalData": {
"props": {
"prop": [
{
"name": "CUSTOM_COLUMN1",
"value": "John"
},
{
"name": "MOBILE_NUMBER_",
"value": "9632155746"
}
]
}
}
}
Web Push Bounced
{
"campaignId": "151332521",
"riid": "23309",
"failureReason": "Subscription is expired/Endpoint Not Found",
"failureType": "WEBPUSH_BOUNCED",
"channelType": "WebPush",
"campaignName": "Summer Promotions"
}
Web Push Closed
{
"campaignId": "151367801",
"riid": "835122601",
"failureType": "WEBPUSH_CLOSED",
"channelType": "WebPush",
"campaignName": "Summer Promotions"
}
Web Push Failed
{
"campaignId": "151354081",
"riid": "836412861",
"failureReason": "Fail Launch",
"failureType": "WEBPUSH_FAILED",
"channelType": "WebPush",
"campaignName": "Summer Promotions"
}
Web Push Opt In
{
"campaignId": "-1",
"riid": "334235767",
"customerId": null,
"failureType": "WEBPUSH_OPTIN",
"channelType": "WebPush",
"campaignName": "N/A",
"optionalData": null
}
Web Push Opt Out
{
"campaignId": "-1",
"riid": "334235767",
"customerId": null,
"failureType": "WEBPUSH_OPTOUT",
"channelType": "WebPush",
"campaignName": "N/A",
"optionalData": null
}
Web Push Skipped
{
"campaignId": "151354081",
"riid": "836212461",
"failureReason": "Skip Launch;",
"failureType": "WEBPUSH_SKIPPED",
"channelType": "WebPush",
"campaignName": "Summer Promotions"
}