Sha256: 883c211448046578d43cfe0a77a951102cd4dcd96011cb5d39f3a1cf69f697df

Contents?: true

Size: 1.63 KB

Versions: 35

Compression:

Stored size: 1.63 KB

Contents

# UltracartClient::WebhookEventSubscription

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **comments** | **String** | Comment about the event to provide further clarification to the end user | [optional] |
| **deprecated_flag** | **Boolean** | True if the event is deprecated.  See the API change log for details on when it will be discontinued. | [optional] |
| **discontinued_flag** | **Boolean** | True if the event is discontinued.  See the API change log for details on migration details. | [optional] |
| **event_description** | **String** | Description of the event | [optional] |
| **event_name** | **String** | Event name | [optional] |
| **event_ruler** | **String** | Optional - Event ruler expression to filter events to.  Only events that match this Ruler expression will be transmitted to the webhook. | [optional] |
| **expansion** | **String** | The expand string for the notification object.  See the individual resource _expand documentation for valid values. | [optional] |
| **subscribed** | **Boolean** | True if this is event is subscribed to | [optional] |
| **supports_reflow** | **Boolean** | True if the event can be triggered to reflow existing records | [optional] |
| **webhook_event_oid** | **Integer** | The webhook event object identifier | [optional] |

## Example

```ruby
require 'ultracart_api'

instance = UltracartClient::WebhookEventSubscription.new(
  comments: null,
  deprecated_flag: null,
  discontinued_flag: null,
  event_description: null,
  event_name: null,
  event_ruler: null,
  expansion: null,
  subscribed: null,
  supports_reflow: null,
  webhook_event_oid: null
)
```

Version data entries

35 entries across 35 versions & 1 rubygems

Version Path
ultracart_api-4.0.237 docs/WebhookEventSubscription.md
ultracart_api-4.0.236 docs/WebhookEventSubscription.md
ultracart_api-4.0.235 docs/WebhookEventSubscription.md
ultracart_api-4.0.234 docs/WebhookEventSubscription.md
ultracart_api-4.0.233 docs/WebhookEventSubscription.md
ultracart_api-4.0.232 docs/WebhookEventSubscription.md
ultracart_api-4.0.231 docs/WebhookEventSubscription.md
ultracart_api-4.0.230 docs/WebhookEventSubscription.md
ultracart_api-4.0.229 docs/WebhookEventSubscription.md
ultracart_api-4.0.228 docs/WebhookEventSubscription.md
ultracart_api-4.0.227 docs/WebhookEventSubscription.md
ultracart_api-4.0.226 docs/WebhookEventSubscription.md
ultracart_api-4.0.225 docs/WebhookEventSubscription.md
ultracart_api-4.0.224 docs/WebhookEventSubscription.md
ultracart_api-4.0.214 docs/WebhookEventSubscription.md
ultracart_api-4.0.213 docs/WebhookEventSubscription.md
ultracart_api-4.0.212 docs/WebhookEventSubscription.md
ultracart_api-4.0.211 docs/WebhookEventSubscription.md
ultracart_api-4.0.210 docs/WebhookEventSubscription.md
ultracart_api-4.0.209 docs/WebhookEventSubscription.md