EndpointDocument

Response Model for Endpoint Document

This is the representation of the EndpointDocument data structure which you receive in the Endpoint API response.

{
  "action": "checkIn",
  "token": "wifhjw93rvkns",
  "url": "https://example.com/checkIn",
  "method": "POST",
  "integrationId": "2c9dc51e-a03a-4356-ac96-35577d9b3c52"
}

Property	Type	Required	Description
action	string	Y	Endpoint action
token	string	Y	A token provided by you to be sent in all API calls as a query parameter, you can check it to make sure we are calling you
url	string	Y	Your endpoint URL
method	string	Y	The HTTP method. It can be POST or GET
integrationId	string	N	The ID of your integration with Goki.

Endpoint Actions

action must be one of the below items. This can extend in the future to support more actions.

Action	Method	Description
getCheckInStatus	GET | POST	This is used to get the status of a reservation in the check-in process.
getSpaces	GET | POST	This is used to get the list of your spaces. In Goki staff can manage room mapping using this endpoint.
checkIn	POST	This is used to check-in a reservation. You need to handle the check-in logic in this endpoint.

Both getCheckInStatus and getSpaces can be registered as POST or GET methods and it is your personal preference to choose which method you like to use. Whether you choose POST or GET the behavior is the same. But you cannot register an action with both methods at the same time.