Instance handshake

Handshake request from Studio to service

post
Instance handshake

https://example-service.lvis.io/lvis
Request
Response
Request
Body Parameters
id
optional
string
Unique identifier across all platform instances, in UUID format.
name
optional
string
Human-readable platform instance name.
auth_endpoint
optional
string
Authentication endpoint.
static_host
optional
string
Static host, which can be used to fetch public feeds.
Response
200: OK
Response on the instance handshake request.
{
"service_id": "demographics",
"service_type": "demographics",
"analytics": true,
"listings_notifications": false,
"elements_notifications": false,
"event_feeds": [
{
"id": "results",
"name": "Segments Results"
},
{
"id": "player_stats",
"name": "Player statistics"
}
],
"event_subscription": {
"types": ["event_created", "event_template_created"],
"path": "/events_endpoint"
}
}

Example

cURL
Response
cURL
curl --request POST \
--url https://example-service.lvis.io/lvis \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"id": "c068dd33-46c3-4789-a619-b14e4bcbe990",
"name": "Development instance",
"auth_endpoint": "https://environment.lvis.io",
"static_host": "d3mssdvj2sslxw.cloudfront.net"
}'
Response
{
"service_id": "demographics",
"service_type": "demographics",
"analytics": true,
"listings_notifications": false,
"elements_notifications": false,
"event_feeds": [
{
"id": "results",
"name": "Segments Results"
},
{
"id": "player_stats",
"name": "Player statistics"
}
],
"event_subscription": {
"types": ["event_created", "event_template_created"],
"path": "/events_endpoint"
}
}

Response parameters

service_id

3rd party service identifier

service_type

Service type

analytics

Optional boolean flag to enable/disable Analytics API

listings_notifications

Flag shows whether Listings notification enabled

elements_notifications

Flag shows whether Elements notification enabled

event_feeds

Service feeds; Optional

event_subscription

Webhook events subscription configuration. Optional. When omitted, current subscriptions are removed.

Webhook events subscription

In order to subscribe to certain webhook events, handshake response must contain event_subscription object.

"event_subscription": {
"types": ["event_created", "event_template_created"],
"path": "/events_endpoint"
}

event_subscription.types - array of supported event types to subscribe. event_subscription.path - path to the webhook endpoint of the service.