Project handshake

Handshake request from LViS to service on new project creation or existing project update.

post
Project handshake

https://example-service.lvis.io/lvis/:lvis_instance_id/projects
Request
Response
Request
Path Parameters
lvis_instance_id
required
string
Unique identifier across all LViS instances, in UUID format.
Body Parameters
project_id
required
string
Project ID.
project_name
required
string
Human-readable project name.
config
required
object
Configuration object as specified in application spec.
api_key
required
string
Bearer token that is required to send Control API requests.
experience_id
optional
string
ID of the experience within which the project was created.
source_project_id
optional
string
Experience source project ID.
Response
200: OK
Response on the project handshake request. Empty JSON object as response body is required.
{}

This endpoint is called when project and service association has changed, which could happen when:

  • New project is created

  • New service is added to existing project

  • Service configuration in the app spec is updated

  • Service is manually reloaded for the project in Studio

It's up to the service to decide if it needs to create a new project within the service database or update existing project based on provided project UUID. In case of an update all body parameters may have changed values.

If api_key has been changed, the previous key has been revoked and not valid anymore.

Example

curl --request POST \
--url https://example-service.lvis.io/lvis/c068dd33-46c3-4789-a619-b14e4bcbe990/projects \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"source_project_id": "55d52333-c801-4408-8d34-764de67d10d1",
"experience_id": "our-awesome-experience",
"project_id": "da34516f-00af-435e-bd03-ab1720755dda",
"project_name": "Project X",
"config": {},
"api_key": "td18FzQxQ8ZgCAc9oHpQis8WJqkEn5B9"
}'