webhookendpoint

Documentation

Overview

Package webhookendpoint provides the /webhook_endpoints APIs

Index

• func Del(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)
• func Get(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)
• func New(params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)
• func Update(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)
• type Client
  • func (c Client) Del(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)
  • func (c Client) Get(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)
  • func (c Client) List(listParams *stripe.WebhookEndpointListParams) *Iter
  • func (c Client) New(params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)
  • func (c Client) Update(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)
• type Iter
  • func List(params *stripe.WebhookEndpointListParams) *Iter
  • func (i *Iter) WebhookEndpoint() *stripe.WebhookEndpoint
  • func (i *Iter) WebhookEndpointList() *stripe.WebhookEndpointList

Functions

func Del

func Del(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)

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

func Get

func Get(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)

Retrieves the webhook endpoint with the given ID.

func New

func New(params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)

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](https://dashboard.stripe.com/account/webhooks) section of the Dashboard.

func Update

func Update(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)

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

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /webhook_endpoints APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)

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

func (Client) Get

func (c Client) Get(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)

Retrieves the webhook endpoint with the given ID.

func (Client) List

func (c Client) List(listParams *stripe.WebhookEndpointListParams) *Iter

Returns a list of your webhook endpoints.

func (Client) New

func (c Client) New(params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)

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](https://dashboard.stripe.com/account/webhooks) section of the Dashboard.

func (Client) Update

func (c Client) Update(id string, params *stripe.WebhookEndpointParams) (*stripe.WebhookEndpoint, error)

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

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for webhook endpoints.

func List

func List(params *stripe.WebhookEndpointListParams) *Iter

Returns a list of your webhook endpoints.

func (*Iter) WebhookEndpoint

func (i *Iter) WebhookEndpoint() *stripe.WebhookEndpoint

WebhookEndpoint returns the webhook endpoint which the iterator is currently pointing to.

func (*Iter) WebhookEndpointList

func (i *Iter) WebhookEndpointList() *stripe.WebhookEndpointList

WebhookEndpointList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.