Class: Stripe::WebhookEndpointService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/webhook_endpoint_service.rb

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance 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 section of the Dashboard.



7
8
9
10
11
12
13
14
15
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 7

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/webhook_endpoints",
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.



18
19
20
21
22
23
24
25
26
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 18

def delete(webhook_endpoint, params = {}, opts = {})
  request(
    method: :delete,
    path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(webhook_endpoint) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Returns a list of your webhook endpoints.



29
30
31
32
33
34
35
36
37
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 29

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/webhook_endpoints",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(webhook_endpoint, params = {}, opts = {}) ⇒ Object

Retrieves the webhook endpoint with the given ID.



40
41
42
43
44
45
46
47
48
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 40

def retrieve(webhook_endpoint, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(webhook_endpoint) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(webhook_endpoint, params = {}, opts = {}) ⇒ Object

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



51
52
53
54
55
56
57
58
59
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 51

def update(webhook_endpoint, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(webhook_endpoint) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end