GUguesty
Webhooks

Get a Webhook subscription

Changed on

Retrieve a single webhook subscription by its ID, including its destination URL and subscribed events. Only webhooks belonging to your account are returned.

get/webhooks/{id}

Request

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

Path parameters

idstring required

Webhook unique Id

Response

Webhook object

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 accountsWebhookGet was added

    • 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