---
title: RealtimeRequestBody
framework: retentionmessaging
role: symbol
role_heading: Object
path: retentionmessaging/realtimerequestbody
---

# RealtimeRequestBody

The request body the App Store server sends to your Get Retention Message endpoint.

## Declaration

```data
object RealtimeRequestBody
```

## Properties

signedPayload: The payload in JSON Web Signature (JWS) format, signed by the App Store.

## Mentioned in

Responding to real-time retention messaging requests Setting up your Get Retention Message endpoint

## Discussion

Discussion This is the request body for the Get Retention Message endpoint, which you can implement to choose retention messages for customers in real time. For more information about the endpoint, see Setting up your Get Retention Message endpoint. The signedPayload is a string of three Base64URL-encoded components separated by a period. The string contains the JWS Compact Serialization of the real-time request, signed by the App Store according to the JSON Web Signature (JWS) IETF RFC 7515 specification. The three components of the string are a header, a payload, and a signature, in that order. To read the real-time request information, Base64URL-decode the payload. Use a DecodedRealtimeRequestBody object to read the payload information. To read the header, decode it and use a JWSDecodedHeader object to access the information. Use the information in the header to verify the signature.

## See Also

### Real-time retention messaging setup

- [Setting up your Get Retention Message endpoint](retentionmessaging/setting-up-retention-messaging-endpoint.md)
- [Configure Realtime URL](retentionmessaging/configure-realtime-url.md)
- [Get Realtime URL](retentionmessaging/get-realtime-url.md)
- [Delete Realtime URL](retentionmessaging/delete-realtime-url.md)
- [RealtimeUrlRequest](retentionmessaging/realtimeurlrequest.md)
- [RealtimeUrlResponse](retentionmessaging/realtimeurlresponse.md)