Class: Zavudev::Models::SenderWebhook

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/sender_webhook.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(active:, events:, url:, secret: nil) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::SenderWebhook for more details.

Webhook configuration for the sender.

Parameters:

  • active (Boolean) —

    Whether the webhook is active.

  • events (Array<Symbol, Zavudev::Models::WebhookEvent>) —

    List of events the webhook is subscribed to.

  • url (String) —

    HTTPS URL that will receive webhook events.

  • secret (String) (defaults to: nil) —

    Webhook secret for signature verification. Only returned on create or regenerate




# File 'lib/zavudev/models/sender_webhook.rb', line 31

Instance Attribute Details

#active ⇒ Boolean

Whether the webhook is active.

Returns:

  • (Boolean) 


10
 
# File 'lib/zavudev/models/sender_webhook.rb', line 10

required :active, Zavudev::Internal::Type::Boolean

#events ⇒ Array<Symbol, Zavudev::Models::WebhookEvent>

List of events the webhook is subscribed to.

Returns:



16
 
# File 'lib/zavudev/models/sender_webhook.rb', line 16

required :events, -> { Zavudev::Internal::Type::ArrayOf[enum: Zavudev::WebhookEvent] }

#secret ⇒ String?

Webhook secret for signature verification. Only returned on create or regenerate.

Returns:

  • (String, nil) 


29
 
# File 'lib/zavudev/models/sender_webhook.rb', line 29

optional :secret, String

#url ⇒ String

HTTPS URL that will receive webhook events.

Returns:

  • (String) 


22
 
# File 'lib/zavudev/models/sender_webhook.rb', line 22

required :url, String