Sign in

v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB
WebhookSubscriptions

Create a new webhook subscription.

post/v2/webhooksubscriptions

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 when Type is Change. Null for all changes. (See /v2/webhooksubscriptions/categories for a list of possible values.)

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 when Type is Change. Null for all changes. (See /v2/webhooksubscriptions/categories for a list of possible values.)

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.