Register an Endpoint

Edit or update your endpoints

Once a customer has entered their access token in your system, you need to register your endpoints in Goki.

Endpoints are registered per integration (per property). You need to use a different URL to separate each property or use the token variable in the endpoint to authenticate/detect your property.

Register an Endpoint

PATCH [environmentBaseUrl]/v1/endpoints

This endpoint allows you to add or update an endpoint. If you use the same action name which was submitted before, it means we need to update it.

Request Body

Name	Type	Description
url	string	Your endpoint URL.
action	string	Endpoint action (please read the Endpoints page).
token	string	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.
method	string	The method can be POST or GET

200 Endpoint successfully registered.

{
    "data": {
        ...EndpointDocument // Check EndpointDocument page for the sample data
    }
}