Class: Sendly::WebhooksResource

Inherits:
Object
  • Object
show all
Defined in:
lib/sendly/webhooks_resource.rb

Overview

Webhooks resource for managing webhook endpoints

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WebhooksResource

Returns a new instance of WebhooksResource.

Parameters:



7
8
9
 
# File 'lib/sendly/webhooks_resource.rb', line 7

def initialize(client)
  @client = client
end

Instance Method Details

#create(url:, events:, description: nil, mode: nil, metadata: nil) ⇒ Sendly::WebhookCreatedResponse

Create a new webhook endpoint

Examples:

webhook = client.webhooks.create(
  url: "https://example.com/webhooks",
  events: ["message.delivered", "message.failed"],
  mode: "all"
)
puts "Secret: #{webhook.secret}"  # Save this - only shown once!

Parameters:

  • url (String) —

    HTTPS endpoint URL

  • events (Array<String>) —

    Event types to subscribe to

  • description (String, nil) (defaults to: nil) —

    Optional description

  • mode (String, nil) (defaults to: nil) —

    Event mode filter: “all”, “test”, or “live” (live requires verification)

  • metadata (Hash, nil) (defaults to: nil) —

    Custom metadata

Returns:

Raises:

  • (ArgumentError) 


27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/sendly/webhooks_resource.rb', line 27

def create(url:, events:, description: nil, mode: nil, metadata: nil)
  raise ArgumentError, "Webhook URL must be HTTPS" unless url&.start_with?("https://")
  raise ArgumentError, "At least one event type is required" if events.nil? || events.empty?

  body = { url: url, events: events }
  body[:description] = description if description
  body[:mode] = mode if mode
  body[:metadata] = metadata if metadata

  response = @client.post("/webhooks", body)
  WebhookCreatedResponse.new(response)
end

#delete(webhook_id) ⇒ void

This method returns an undefined value.

Delete a webhook

Parameters:

  • webhook_id (String) —

    Webhook ID



88
89
90
91
92
 
# File 'lib/sendly/webhooks_resource.rb', line 88

def delete(webhook_id)
  validate_webhook_id!(webhook_id)
  @client.delete("/webhooks/#{webhook_id}")
  nil
end

#deliveries(webhook_id) ⇒ Array<Sendly::WebhookDelivery>

Get delivery history for a webhook

Parameters:

  • webhook_id (String) —

    Webhook ID

Returns:



127
128
129
130
131
 
# File 'lib/sendly/webhooks_resource.rb', line 127

def deliveries(webhook_id)
  validate_webhook_id!(webhook_id)
  response = @client.get("/webhooks/#{webhook_id}/deliveries")
  response.map { |data| WebhookDelivery.new(data) }
end

#event_types ⇒ Array<String>

List available event types

Returns:

  • (Array<String>) 


148
149
150
151
 
# File 'lib/sendly/webhooks_resource.rb', line 148

def event_types
  response = @client.get("/webhooks/event-types")
  (response["events"] || []).map { |e| e["type"] }
end

#get(webhook_id) ⇒ Sendly::Webhook

Get a specific webhook by ID

Parameters:

  • webhook_id (String) —

    Webhook ID (whk_xxx)

Returns:



52
53
54
55
56
 
# File 'lib/sendly/webhooks_resource.rb', line 52

def get(webhook_id)
  validate_webhook_id!(webhook_id)
  response = @client.get("/webhooks/#{webhook_id}")
  Webhook.new(response)
end

#list ⇒ Array<Sendly::Webhook>

List all webhooks

Returns:



43
44
45
46
 
# File 'lib/sendly/webhooks_resource.rb', line 43

def list
  response = @client.get("/webhooks")
  response.map { |data| Webhook.new(data) }
end

#reset_circuit(webhook_id) ⇒ Hash

Reset the circuit breaker for a webhook

Parameters:

  • webhook_id (String) —

    Webhook ID

Returns:

  • (Hash) —

    Reset confirmation with updated webhook



108
109
110
111
 
# File 'lib/sendly/webhooks_resource.rb', line 108

def reset_circuit(webhook_id)
  validate_webhook_id!(webhook_id)
  @client.post("/webhooks/#{webhook_id}/reset-circuit")
end

#retry_delivery(webhook_id, delivery_id) ⇒ void

This method returns an undefined value.

Retry a failed delivery

Parameters:

  • webhook_id (String) —

    Webhook ID

  • delivery_id (String) —

    Delivery ID



138
139
140
141
142
143
 
# File 'lib/sendly/webhooks_resource.rb', line 138

def retry_delivery(webhook_id, delivery_id)
  validate_webhook_id!(webhook_id)
  validate_delivery_id!(delivery_id)
  @client.post("/webhooks/#{webhook_id}/deliveries/#{delivery_id}/retry")
  nil
end

#rotate_secret(webhook_id) ⇒ Sendly::WebhookSecretRotation

Rotate the webhook signing secret

Parameters:

  • webhook_id (String) —

    Webhook ID

Returns:



117
118
119
120
121
 
# File 'lib/sendly/webhooks_resource.rb', line 117

def rotate_secret(webhook_id)
  validate_webhook_id!(webhook_id)
  response = @client.post("/webhooks/#{webhook_id}/rotate-secret")
  WebhookSecretRotation.new(response)
end

#test(webhook_id) ⇒ Sendly::WebhookTestResult

Test a webhook endpoint

Parameters:

  • webhook_id (String) —

    Webhook ID

Returns:



98
99
100
101
102
 
# File 'lib/sendly/webhooks_resource.rb', line 98

def test(webhook_id)
  validate_webhook_id!(webhook_id)
  response = @client.post("/webhooks/#{webhook_id}/test")
  WebhookTestResult.new(response)
end

#update(webhook_id, url: nil, events: nil, description: nil, is_active: nil, mode: nil, metadata: nil) ⇒ Sendly::Webhook

Update a webhook configuration

Parameters:

  • webhook_id (String) —

    Webhook ID

  • url (String, nil) (defaults to: nil) —

    New URL

  • events (Array<String>, nil) (defaults to: nil) —

    New event subscriptions

  • description (String, nil) (defaults to: nil) —

    New description

  • is_active (Boolean, nil) (defaults to: nil) —

    Enable/disable webhook

  • mode (String, nil) (defaults to: nil) —

    Event mode filter: “all”, “test”, or “live”

  • metadata (Hash, nil) (defaults to: nil) —

    Custom metadata

Returns:

Raises:

  • (ArgumentError) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/sendly/webhooks_resource.rb', line 68

def update(webhook_id, url: nil, events: nil, description: nil, is_active: nil, mode: nil, metadata: nil)
  validate_webhook_id!(webhook_id)
  raise ArgumentError, "Webhook URL must be HTTPS" if url && !url.start_with?("https://")

  body = {}
  body[:url] = url unless url.nil?
  body[:events] = events unless events.nil?
  body[:description] = description unless description.nil?
  body[:is_active] = is_active unless is_active.nil?
  body[:mode] = mode unless mode.nil?
  body[:metadata] = metadata unless metadata.nil?

  response = @client.patch("/webhooks/#{webhook_id}", body)
  Webhook.new(response)
end