OWownerrez
WebhookSubscriptions

Create a new webhook subscription.

Changed on
post/v2/webhooksubscriptions

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/v2/webhooksubscriptions
  • Auth
    • HTTP bearer
    • or HTTP basic

Request body

idinteger

The ID of this record.

action'entity_create' | 'entity_update' | 'entity_delete' | 'application_authorization_revoked' | 'webhook_test'

The record action that triggers a webhook to be sent to a subscription.

api_application_connection_idinteger

The ID of the API application connection which owns this subscription.

categorystring

The category of changes to send to this webhook URL. Null for all changes. Requires Type to be exactly one of booking, guest or property, and an unknown name is rejected. application_authorization_revoked checks Category the same way and stores none. (See /v2/webhooksubscriptions/categories for a list of possible values; it lists guest categories under Contact.)

type'none' | 'booking' | 'guest' | 'property' | 'message' | 'quote' | 'inquiry' | 'surcharge' | 'discount'
webhook_urlstring uri required

The URL to which webhooks should be sent for this subscription.

Response

A model representing the webhook subscription created.

idinteger

The ID of this record.

action'entity_create' | 'entity_update' | 'entity_delete' | 'application_authorization_revoked' | 'webhook_test'

The record action that triggers a webhook to be sent to a subscription.

api_application_connection_idinteger

The ID of the API application connection which owns this subscription.

categorystring

The category of changes to send to this webhook URL. Null for all changes. Requires Type to be exactly one of booking, guest or property, and an unknown name is rejected. application_authorization_revoked checks Category the same way and stores none. (See /v2/webhooksubscriptions/categories for a list of possible values; it lists guest categories under Contact.)

type'none' | 'booking' | 'guest' | 'property' | 'message' | 'quote' | 'inquiry' | 'surcharge' | 'discount'
webhook_urlstring uri required

The URL to which webhooks should be sent for this subscription.

Changes

  • 838877899156Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 00db66c44181Revision changes
    • info

      api operation id WebhookSubscriptions_Post removed and replaced with post-webhooksubscriptions