---
title: Get Realtime URL
framework: retentionmessaging
role: symbol
role_heading: Web Service Endpoint
path: retentionmessaging/get-realtime-url
---

# Get Realtime URL

Gets the URL for real-time messages that points to your Get Retention Message endpoint, which you previously configured.

## URL

GET https://api.storekit.apple.com/inApps/v1/messaging/realtime/url

## Sandbox URL

GET https://api.storekit-sandbox.apple.com/inApps/v1/messaging/realtime/url

## Response Codes

200 OK: Request succeeded. 401 Unauthorized: The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests. 404 Not Found: The Get Retention Message URL wasn’t found. 429 : The request exceeded the rate limit. For more information, see Identifying rate limits. 500 Internal Server Error: Server error. Try again later.

## Mentioned in

Identifying rate limits Retention Messaging API changelog Setting up your Get Retention Message endpoint

## Discussion

Discussion This endpoint returns your Get Retention Message endpoint’s URL. The URL it provides is specific to the environment (sandbox or production) you use to call Get Realtime URL. This endpoint returns an HTTP 404 error with RealtimeUrlNotFoundError if the URL isn’t configured. For more information on configuring your Get Retention Message endpoint, see Setting up your Get Retention Message endpoint.

## 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)
- [Delete Realtime URL](retentionmessaging/delete-realtime-url.md)
- [RealtimeUrlRequest](retentionmessaging/realtimeurlrequest.md)
- [RealtimeRequestBody](retentionmessaging/realtimerequestbody.md)
- [RealtimeUrlResponse](retentionmessaging/realtimeurlresponse.md)