Instance handshake
Handshake request from Studio to an Extension
post
https://example-service.lvis.io
/lvis
Instance handshake
cURL
Response
curl --request POST \
--url https://example-extension.mic.io/mic \
--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"
}'
{
"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"
}
}
| |
service_id | 3rd party service identifier |
service_type | |
analytics | |
listings_notifications | |
elements_notifications | |
event_feeds | |
event_subscription | Webhook events subscription configuration. Optional. When omitted, current subscriptions are removed. |
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.Last modified 9mo ago