Module: Paperdrive::Client::Webhooks

Includes:
Parameters
Included in:
Paperdrive::Client
Defined in:
lib/paperdrive/client/webhooks.rb

Overview

Instance methods related to Webhooks to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.

See Also:

Instance Method Summary collapse

Instance Method Details

#all_webhooks(**args) ⇒ Paperdrive::Response

GET

Get all webhooks

Returns:

See Also:



18
19
20
21
22
23
 
# File 'lib/paperdrive/client/webhooks.rb', line 18

def all_webhooks(**args)
  params = parameters(args) do
    optional_params
  end
  request(:get, 'webhooks', params)
end

#create_webhook(**args) ⇒ Paperdrive::Response

POST

Create a new webhook

Returns:

See Also:



29
30
31
32
33
34
35
 
# File 'lib/paperdrive/client/webhooks.rb', line 29

def create_webhook(**args)
  params = parameters(args) do
    required_params :subscription_url, :event_action, :event_object
    optional_params :subscription_url, :event_action, :event_object, :user_id, :http_auth_user, :http_auth_password
  end
  request(:post, 'webhooks', params)
end

#delete_webhook(id:, **args) ⇒ Paperdrive::Response

DELETE

Delete existing webhook

Parameters:

  • id: (integer)

Returns:

See Also:



42
43
44
45
46
47
 
# File 'lib/paperdrive/client/webhooks.rb', line 42

def delete_webhook(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "webhooks/#{id}", params)
end