Webhooks

Let Goki trigger your webhook on different events

You can register your webhooks on Goki and get updates on particular events. For now, each third-party app can register only one webhook which will be subscribed to all events automatically.

Your webhook’s method should be POST as we need to submit data to you.

Any response in the range of 2xx will be considered successful. Otherwise, we will trigger the webhook two more times with exponential backoff.

Available Events

1) reservationPinGenerated

Currently, the only available webhook event is reservationPinGenerated. Once you register for it, we will call your API whenever a pin is generated on the reservation with the below information:

{ 
  event: ‘reservationPinGenerated’,
  data: {
    ...ReservationDocument, // Check ReservationDocument for sample data
    "webAppUrl": "https://reservation.goki.app?action=claim&pmsNumber=563&lastName=doe&email=[e-mail]&auth=e91523a500a44cd7d4fb90290ddf1f5c8635bbff88ef3488204621a3432fd3e1&reservationId=7269d639-e3df-4b7e-9aa7-5fe6e80e762e",
    "pin": "2817628",
    "gatesPins": [          // Common area PINs. It's an empty array when there is no common area PINs.
      {
        "gateId": "f5004750-a11f-4641-9033-4245a77a1e46",
        "gateName": "TV Room",
        "pin": "45863456"
      }
    ]
  }
} 

To get a PIN your room should have a SmartLock or a SmartDisc.

You typically do not need this as Goki emails the PINs to the guests when they are checked in.

Data Structure

pageWebhookDocument

APIs

• List Webhooks List all registered webhooks for the current integration.

• Register a Webhook Register a new webhook for the current integration.

• Update a Webhook Update the already registered webhook.

• Remove a Webhook Remove an already registered webhook.