module Paperdrive::Client::Webhooks

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

@see developers.pipedrive.com/docs/api/v1/#!/Webhooks

Public Instance Methods

all_webhooks(**args) click to toggle source
GET

Get all webhooks

@see developers.pipedrive.com/docs/api/v1/#!/Webhooks/get_webhooks @return [Paperdrive::Response]

# 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) click to toggle source
POST

Create a new webhook

@see developers.pipedrive.com/docs/api/v1/#!/Webhooks/post_webhooks @return [Paperdrive::Response]

# 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) click to toggle source
DELETE

Delete existing webhook

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Webhooks/delete_webhooks_id @return [Paperdrive::Response]

# 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