View Source ExOAPI.Stripe.SDK.WebhookEndpoints (exoapi_stripe v0.1.1)
Link to this section Summary
Functions
description: <p>You can also delete webhook endpoints via the <a href="https://dashboard.stripe.com/account/webhooks">webhook endpoint management</a> page of the Stripe dashboard.</p>
description: <p>Returns a list of your webhook endpoints.</p>
description: <p>Retrieves the webhook endpoint with the given ID.</p>
description: <p>A webhook endpoint must have a <code>url</code> and a list of <code>enabled_events</code>. You may optionally specify the Boolean <code>connect</code> parameter. If set to true, then a Connect webhook endpoint that notifies the specified <code>url</code> about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified <code>url</code> only about events from your account is created. You can also create webhook endpoints in the <a href="https://dashboard.stripe.com/account/webhooks">webhooks settings</a> section of the Dashboard.</p>
description: <p>Updates the webhook endpoint. You may edit the <code>url</code>, the list of <code>enabled_events</code>, and the status of your endpoint.</p>
Link to this section Types
@type get_webhook_endpoints_webhook_endpoint_opts() :: {:expand, String.t()}
Link to this section Functions
delete_webhook_endpoints_webhook_endpoint(client, body, webhook_endpoint)
View Source@spec delete_webhook_endpoints_webhook_endpoint( client :: ExOAPI.Client.t(), body :: map(), webhook_endpoint :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>You can also delete webhook endpoints via the <a href="https://dashboard.stripe.com/account/webhooks">webhook endpoint management</a> page of the Stripe dashboard.</p>
@spec get_webhook_endpoints(client :: ExOAPI.Client.t(), [ get_webhook_endpoints_opts() ]) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of your webhook endpoints.</p>
get_webhook_endpoints_webhook_endpoint(client, webhook_endpoint, opts \\ [])
View Source@spec get_webhook_endpoints_webhook_endpoint( client :: ExOAPI.Client.t(), webhook_endpoint :: String.t(), [get_webhook_endpoints_webhook_endpoint_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves the webhook endpoint with the given ID.</p>
@spec post_webhook_endpoints(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>A webhook endpoint must have a <code>url</code> and a list of <code>enabled_events</code>. You may optionally specify the Boolean <code>connect</code> parameter. If set to true, then a Connect webhook endpoint that notifies the specified <code>url</code> about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified <code>url</code> only about events from your account is created. You can also create webhook endpoints in the <a href="https://dashboard.stripe.com/account/webhooks">webhooks settings</a> section of the Dashboard.</p>
post_webhook_endpoints_webhook_endpoint(client, body, webhook_endpoint)
View Source@spec post_webhook_endpoints_webhook_endpoint( client :: ExOAPI.Client.t(), body :: map(), webhook_endpoint :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates the webhook endpoint. You may edit the <code>url</code>, the list of <code>enabled_events</code>, and the status of your endpoint.</p>