GUguesty
Webhooks

Create a webhook subscription

Changed on

Subscribe a destination URL to one or more Guesty events. At least one event is required, and every event name must be one of the supported values — an unrecognized name is rejected with 400. An account may hold up to 100 webhooks.

post/webhooks

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/webhooks
  • Auth
    API key in header authorization

Request body

urlstring uri

The endpoint URL that webhook event payloads are sent to.

eventsstring[]

add list of event to register for the provided url. Legacy reservation events (reservation.new, reservation.updated, reservation_update_shortlist) are deprecated and may require temporary allowlist approval.

Example request

{
  "url": "https://www.hookurl.com"
}

Response

The created webhook

accountIdstring

Unique Guesty account ID.

_idstring

Unique Id

urlstring uri

The endpoint URL that webhook event payloads are sent to.

eventsstring[]

add list of event to register for the provided url. Legacy reservation events (reservation.new, reservation.updated, reservation_update_shortlist) are deprecated and may require temporary allowlist approval.

Example response

{
  "accountId": "563e0b6a08a2710e00057b82",
  "_id": "563e0b6a08a2710e00057b82",
  "url": "https://www.hookurl.com"
}

Changes

  • 3122b8618183Revision changes
    • breaking

      removed the enum value calendar.updated.v2 of the request property

    • breaking

      removed the enum value guest.created of the request property

    • breaking

      removed the enum value guest.deleted of the request property

    • breaking

      removed the enum value guest.updated of the request property

    • breaking

      removed the enum value listing.calendar.updated of the request property

    • breaking

      removed the enum value listing.new of the request property

    • breaking

      removed the enum value listing.removed of the request property

    • breaking

      removed the enum value listing.updated of the request property

    • breaking

      removed the enum value payments.failed of the request property

    • breaking

      removed the enum value payments.method.received of the request property

    • breaking

      removed the enum value reservation.created.v2 of the request property

    • breaking

      removed the enum value reservation.messageReceived of the request property

    • breaking

      removed the enum value reservation.messageSent of the request property

    • breaking

      removed the enum value reservation.new of the request property

    • breaking

      removed the enum value reservation.updated of the request property

    • breaking

      removed the enum value reservation.updated.v2 of the request property

    • breaking

      removed the enum value reservation_update_shortlist of the request property

    • breaking

      removed the enum value task.created of the request property

    • breaking

      removed the enum value task.deleted of the request property

    • breaking

      removed the enum value task.updated of the request property

    • breaking

      the request property format changed from no format to uri

    • info

      api operation id accountsWebhookCreate was added

    • info

      added the new guest-folio.created enum value to the request property /

    • info

      added the new guest-folio.updated enum value to the request property /

    • info

      added the new payments.authenticationRequired enum value to the request property /

    • info

      added the new payments.authorizationHoldFailed enum value to the request property /

    • info

      added the new payments.disputes enum value to the request property /

    • info

      added the new payments.invalidPaymentMethod enum value to the request property /

    • info

      added the new payments.overcharge.expected enum value to the request property /

    • info

      added the new payments.overcharged enum value to the request property /

    • info

      added the new payments.overdue enum value to the request property /

    • info

      added the new payments.received enum value to the request property /

    • info

      added the new payments.refunded enum value to the request property /

    • info

      added subschema #1 subschema #3 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #3 from the response body allOf list for the response status

    • info

      added the non-success response with the status