MyMessages Notifications

With My Messages notifications, you receive messages when new eBay messages or member to member messages (M2M) are received in your My Messages mailbox. These messages can contain only header information, or the full header and message body, depending on the amount of detail you subscribe to. Both buyers and sellers can subscribe to these notifications.

Before using these notifications, be sure that you have read and understood the information in Working with Platform Notifications.

The data fields returned in these notifications are the same as those returned by GetMyMessagesResponse. See GetMyMessagesResponseType in the Type reference.

See SOAP Message Body for details on the standard elements returned for all notifications.

MyMessages Notification

Some special rules apply to subscribing to My Messages notifications with SetNotificationPreferences. Though you can choose to be notified of both types of My Messages mail (messages from eBay and member to member (M2M) messages), you can only subscribe to one amount of detail at a time. For example, you cannot subscribe to both MyMessagesM2MMessageHeader (GetMyMessages with a detail level of ReturnHeaders) and MyMessagesM2MMessage (GetMyMessages with a detail level of ReturnMessages) at the same time.

Subscribing to a MyMessages Notification

To subscribe to a My Messages notification at a specified amount of detail (for example, headers instead of the full alert or message body):

Subscribing to a Different Amount of Detail

To subscribe to a different amount of detail (for example, from MyMessagesM2MMessageHeader to MyMessagesM2MMessage):

  1. First call SetNotificationPreferences with an EventType value of MyMessagesM2MMessageHeader and an EventEnable value of Disable.
  2. Next call SetNotificationPreferences with an EventType value of MyMessagesM2MMessage and an EventEnable value of Enable.

MyMessagesAlert Notification

This is a notification type where a specified user or application is notified when an alert is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnMessages. MyMessagesAlertHeader and MyMessagesAlert cannot be subscribed to at the same time or specified in the same call.

MyMessagesAlertHeader Notification

This is a notification type where a specified user or application is notified when an alert is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnHeaders. MyMessagesAlertHeader and MyMessagesAlert cannot be subscribed to at the same time or specified in the same call.

Example

The following sample shows a MyMessagesAlertHeader notification.

Sample MyMessagesAlertHeader Notification

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://
www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <ebl:RequesterCredentials soapenv:mustUnderstand="0" xmlns:ns="urn:ebay:apis:eBLBaseComponents" xmlns:ebl="urn:ebay:apis:eBLBaseComponents">
      <ebl:NotificationSignature xmlns:ebl="urn:ebay:apis:eBLBaseComponents">ABC123==
      </ebl:NotificationSignature>
    </ebl:RequesterCredentials>
  </soapenv:Header>
  <soapenv:Body>
    <GetMyMessagesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
      <Timestamp>2005-08-04T21:39:12.514Z</Timestamp>
      <Ack>Success</Ack>
      <CorrelationID>94651830</CorrelationID>
      <Version>423</Version>
      <Build>e423_core_API_1556612_R1</Build>
      <NotificationEventName>MyMessagesAlertHeader</NotificationEventName>
      <RecipientUserID>sampleuser</RecipientUserID>
      <Alerts>
        <Alert>
          <Sender>eBay</Sender>
          <RecipientUserID>sampleuser</RecipientUserID>
          <Subject>Important Alert</Subject>
          <Priority>3200</Priority>
          <AlertID>100856011</AlertID>
          <ResolutionStatus>Unresolved</ResolutionStatus>
          <Read>false</Read>
          <ReceiveDate>2005-08-04T21:23:09.000Z</ReceiveDate>
          <ExpirationDate>2006-04-01T22:00:00.000Z</ExpirationDate>
          <IsTimedResolution>false</IsTimedResolution>
          <ActionURL>https://resolvethis.com</ActionURL>
          <ResponseDetails>
            <ResponseEnabled>false</ResponseEnabled>
          </ResponseDetails>
          <Folder>
            <FolderID>0</FolderID>
          </Folder>
        </Alert>
      </Alerts>
    </GetMyMessagesResponse>
  </soapenv:Body>
</soapenv:Envelope>

MyMessageseBayMessage Notification

This is a notification type where a specified user or application is notified when a message from eBay is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnMessages. MyMessageseBayMessageHeader and MyMessageseBayMessage cannot be subscribed to at the same time or specified in the same call.

MyMessageseBayMessageHeader Notification

This is a notification type where a specified user or application is notified when a message from eBay is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnHeaders. MyMessageseBayMessageHeader and MyMessageseBayMessage cannot be subscribed to at the same time or specified in the same call.

Example

The following sample shows a MyMessageseBayMessageHeader notification.

Sample MyMessageseBayMessageHeader Notification

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://
www.w3.org/2001/XMLSchema"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
 <soapenv:Header>
  <ebl:RequesterCredentials soapenv:mustUnderstand="0"
 xmlns:ns="urn:ebay:apis:eBLBaseComponents"
 xmlns:ebl="urn:ebay:apis:eBLBaseComponents">
   <ebl:NotificationSignature xmlns:ebl="urn:ebay:apis:eBLBaseComponents">ABC123==
 </ebl:NotificationSignature>
  </ebl:RequesterCredentials>
 </soapenv:Header>
 <soapenv:Body>
  <GetMyMessagesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2005-08-04T22:52:20.701Z</Timestamp>
   <Ack>Success</Ack>
   <CorrelationID>94654140</CorrelationID>
   <Version>423</Version>
   <Build>e423_core_API_1556612_R1</Build>
   <NotificationEventName>MyMessageseBayMessageHeader</NotificationEventName>
   <RecipientUserID>sampleuser</RecipientUserID>
   <Messages>
    <Message>
     <Sender>testuser</Sender>
     <RecipientUserID>sampleuser</RecipientUserID>
     <Subject>The request with originalMessageId</Subject>
     <MessageID>1989403</MessageID>
     <Flagged>false</Flagged>
     <Read>false</Read>
     <ReceiveDate>2005-08-04T22:52:08.000Z</ReceiveDate>
     <ExpirationDate>2005-10-03T22:52:08.000Z</ExpirationDate>
     <ResponseDetails>
      <ResponseEnabled>false</ResponseEnabled>
     </ResponseDetails>
     <Folder>
      <FolderID>0</FolderID>
     </Folder>
    </Message>
   </Messages>
  </GetMyMessagesResponse>
 </soapenv:Body>
</soapenv:Envelope>

MyMessagesM2MMessage Notification

This is a notification type where a specified user or application is notified when a member to member (M2M) message is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnMessages. MyMessagesM2MMessageHeader and MyMessagesM2MMessage cannot be subscribed to at the same time or specified in the same call.

MyMessagesM2MMessageHeader Notification

This is a notification type where a specified user or application is notified when a member to member (M2M) message is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnHeaders. MyMessagesM2MMessageHeader and MyMessagesM2MMessage cannot be subscribed to at the same time or specified in the same call.