Download OpenAPI specification:Download
API you can use to manage your Live Me Up resources
Get displayed lives and replays
| x-livemeup-tenant-name required | string (TenantNameHeader) Example: shopname.myshopify.com The unique tenant name. For Shopify shops it is in the format of "shopname.myshopify.com" |
Example of a response when tenant displays one upcoming live and two replays
{- "askEmail": true,
- "askSMS": true,
- "highlightedEvents": [
- {
- "description": "Live Event Test",
- "id": "86ac818d-6eae-43c0-982e-d9c74200a230",
- "showTime": "2024-10-01T21:00:00.701Z",
- "status": "ON_AIR",
- "title": "Test1-Live"
}
], - "publishedReplayEvents": [
- {
- "description": "asdasd",
- "id": "40ccc128-5bb5-49ef-8817-66a31d24832b",
- "showTime": "2024-09-26T08:37:57.000Z",
- "status": "REPLAY",
- "title": "mobile test"
}, - {
- "description": "Android Live Stream Test",
- "id": "9bd3a31b-94c1-43e4-ba3c-52787cd6d09f",
- "showTime": "2024-10-01T10:26:00.963Z",
- "status": "REPLAY",
- "title": "Android Event Test"
}
], - "replaySectionTitle": "Replays"
}Get displayed live and replays. This endpoint is deprecated, please implement the v2 instead.
| x-livemeup-tenant-name required | string (TenantNameHeader) Example: shopname.myshopify.com The unique tenant name. For Shopify shops it is in the format of "shopname.myshopify.com" |
Example of a response when tenant display one upcoming live and two replays
{- "askEmail": true,
- "highlightedEvent": {
- "description": "Live Event Test",
- "id": "86ac818d-6eae-43c0-982e-d9c74200a230",
- "showTime": "2024-10-01T21:00:00.701Z",
- "status": "ON_AIR",
- "title": "Test1-Live"
}, - "publishedReplayEvents": [
- {
- "description": "asdasd",
- "id": "40ccc128-5bb5-49ef-8817-66a31d24832b",
- "showTime": "2024-09-26T08:37:57.000Z",
- "status": "REPLAY",
- "title": "mobile test"
}, - {
- "description": "Android Live Stream Test",
- "id": "9bd3a31b-94c1-43e4-ba3c-52787cd6d09f",
- "showTime": "2024-10-01T10:26:00.963Z",
- "status": "REPLAY",
- "title": "Android Event Test"
}
], - "replaySectionTitle": "Replays"
}Register a phone number to receive an SMS reminder before an event starts. Idempotent on (eventId, phoneNumber).
| eventId required | string <uuid> Example: 86ac818d-6eae-43c0-982e-d9c74200a230 The event the reminder is created for |
| x-livemeup-tenant-name required | string (TenantNameHeader) Example: shopname.myshopify.com The unique tenant name. For Shopify shops it is in the format of "shopname.myshopify.com" |
| commercialInfoConsent required | boolean |
| eventURL required | string Should be the URL of the page, will be included in the sent SMS |
| firstName required | string |
| locale required | string |
| phoneNumber required | string |
{- "commercialInfoConsent": true,
- "firstName": "Jane",
- "locale": "fr-FR",
- "phoneNumber": "+33612345678"
}HMAC-SHA256 authenticated endpoints for Intelligence Cloud to access replay transcripts and chat messages. Authentication uses a canonical string format: {METHOD}\n{PATH}\n{SORTED_QUERY}\n{BODY}\n{TIMESTAMP}. The HMAC-SHA256 digest is sent in the x-ic-signature header, and the timestamp in the x-ic-timestamp header.
List available replay events for a given tenant with data readiness statuses (transcript and chat export availability)
| tenant required | string Example: tenant=storename.myshopify.com The tenant name to list replays for |
| since required | string <date-time> Example: since=2026-03-01T00:00:00Z ISO 8601 date — only replays with startTime >= since are returned. Must be within the last 60 days. |
| x-ic-signature required | string HMAC-SHA256 signature of the canonical request string |
| x-ic-timestamp required | string ISO 8601 timestamp of the request — must be within ±5 minutes of server time |
[- {
- "id": "evt-123",
- "title": "Live Shopping Event",
- "startTime": "2026-03-01T10:00:00.000Z",
- "transcriptStatus": "ready"
}
]Trigger export of chat messages and return signed URLs for both chat and transcript files. If the chat export already exists, the upload is skipped (idempotent). Signed URLs expire in 1 hour.
| replayId required | string Example: evt-123 The replay event ID to export data for |
| x-ic-signature required | string HMAC-SHA256 signature of the canonical request string |
| x-ic-timestamp required | string ISO 8601 timestamp of the request — must be within ±5 minutes of server time |
{
}