Class: Stripe::WebhookEndpoint

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Delete, APIOperations::Save
Defined in:
lib/stripe/resources/webhook_endpoint.rb

Overview

You can configure [webhook endpoints](docs.stripe.com/webhooks/) via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from [the dashboard](dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.

Related guide: [Setting up webhooks](docs.stripe.com/webhooks/configure)

Constant Summary collapse

OBJECT_NAME = 
"webhook_endpoint"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods included from APIOperations::Delete

included

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the [webhooks settings](dashboard.stripe.com/account/webhooks) section of the Dashboard.



24
25
26
27
28
29
30
31
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 24

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/webhook_endpoints",
    params: params,
    opts: opts
  )
end

.delete(id, params = {}, opts = {}) ⇒ Object

You can also delete webhook endpoints via the [webhook endpoint management](dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.



34
35
36
37
38
39
40
41
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 34

def self.delete(id, params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/webhook_endpoints/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.list(filters = {}, opts = {}) ⇒ Object

Returns a list of your webhook endpoints.



54
55
56
57
58
59
60
61
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 54

def self.list(filters = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/webhook_endpoints",
    params: filters,
    opts: opts
  )
end

.object_name ⇒ Object 



19
20
21
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 19

def self.object_name
  "webhook_endpoint"
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.



64
65
66
67
68
69
70
71
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 64

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/webhook_endpoints/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#delete(params = {}, opts = {}) ⇒ Object

You can also delete webhook endpoints via the [webhook endpoint management](dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.



44
45
46
47
48
49
50
51
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 44

def delete(params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end