v24
Instance handshake
Handshake request from Studio to service
post
https://example-service.lvis.io
/lvis
Instance handshake

Example

cURL
Response
1
curl --request POST \
2
--url https://example-service.lvis.io/lvis \
3
--header 'Content-Type: application/vnd.api+json' \
4
--data '{
5
"id": "c068dd33-46c3-4789-a619-b14e4bcbe990",
6
"name": "Development instance",
7
"auth_endpoint": "https://environment.lvis.io",
8
"static_host": "d3mssdvj2sslxw.cloudfront.net"
9
}'
Copied!
1
{
2
"service_id": "demographics",
3
"service_type": "demographics",
4
"analytics": true,
5
"listings_notifications": false,
6
"elements_notifications": false,
7
"event_feeds": [
8
{
9
"id": "results",
10
"name": "Segments Results"
11
},
12
{
13
"id": "player_stats",
14
"name": "Player statistics"
15
}
16
],
17
"event_subscription": {
18
"types": ["event_created", "event_template_created"],
19
"path": "/events_endpoint"
20
}
21
}
Copied!

Response parameters

service_id
3rd party service identifier
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.
1
"event_subscription": {
2
"types": ["event_created", "event_template_created"],
3
"path": "/events_endpoint"
4
}
Copied!
event_subscription.types - array of supported event types to subscribe. event_subscription.path - path to the webhook endpoint of the service.
Last modified 9mo ago