Sha256: 45b87dec39fc7d896845734487338f37bb3ad8b313a000fae7edac97fc6304a3

Contents?: true

Size: 1.18 KB

Versions: 11

Compression:

Stored size: 1.18 KB

Contents

# Phrase::WebhookCreateParameters

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**callback_url** | **String** | Callback URL to send requests to | 
**secret** | **String** | Webhook secret used to calculate signature. If empty, the default project secret will be used. | [optional] 
**description** | **String** | Webhook description | [optional] 
**events** | **String** | List of event names to trigger the webhook (separated by comma) | [optional] 
**active** | **Boolean** | Whether webhook is active or inactive | [optional] 
**include_branches** | **Boolean** | If enabled, webhook will also be triggered for events from branches of the project specified. | [optional] 

## Code Sample

```ruby
require 'Phrase'

instance = Phrase::WebhookCreateParameters.new(callback_url: http://example.com/hooks/phraseapp-notifications,
                                 secret: secr3t,
                                 description: My webhook for chat notifications,
                                 events: locales:create,translations:update,
                                 active: null,
                                 include_branches: null)
```


Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
phrase-3.7.1 docs/WebhookCreateParameters.md
phrase-3.7.0 docs/WebhookCreateParameters.md
phrase-3.6.0 docs/WebhookCreateParameters.md
phrase-3.5.0 docs/WebhookCreateParameters.md
phrase-3.4.0 docs/WebhookCreateParameters.md
phrase-3.3.0 docs/WebhookCreateParameters.md
phrase-3.2.1 docs/WebhookCreateParameters.md
phrase-3.2.0 docs/WebhookCreateParameters.md
phrase-3.1.1 docs/WebhookCreateParameters.md
phrase-3.1.0 docs/WebhookCreateParameters.md
phrase-3.0.0 docs/WebhookCreateParameters.md