Search documentation of stripe_elixir

# StripeElixir.Services.WebhookEndpointService (stripe_elixir v0.1.0)

Copy Markdown View Source

NotificationWebhookEndpoint

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks

## Summary

### Functions

create(client, params \\ %{}, opts \\ [])

Create a webhook endpoint

delete(client, webhook_endpoint, params \\ %{}, opts \\ [])

Delete a webhook endpoint

list(client, params \\ %{}, opts \\ [])

List all webhook endpoints

retrieve(client, webhook_endpoint, params \\ %{}, opts \\ [])

Retrieve a webhook endpoint

update(client, webhook_endpoint, params \\ %{}, opts \\ [])

Update a webhook endpoint

## Functions

# create(client, params \\ %{}, opts \\ [])

    @spec create(StripeElixir.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Create a webhook endpoint

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.

# delete(client, webhook_endpoint, params \\ %{}, opts \\ [])

    @spec delete(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Delete a webhook endpoint

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

# list(client, params \\ %{}, opts \\ [])

    @spec list(StripeElixir.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

List all webhook endpoints

Returns a list of your webhook endpoints.

# retrieve(client, webhook_endpoint, params \\ %{}, opts \\ [])

    @spec retrieve(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Retrieve a webhook endpoint

Retrieves the webhook endpoint with the given ID.

# update(client, webhook_endpoint, params \\ %{}, opts \\ [])

    @spec update(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Update a webhook endpoint

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