GUguesty
Webhooks

List webhook subscriptions

Changed on

Retrieve every webhook subscription registered under your account, including the destination URL and the list of events each one is subscribed to.

get/webhooks

Request

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

Response

Array of requested webhooks

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
    • info

      api operation id accountsWebhookList was added

    • info

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

    • info

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