WorkOS.Webhooks (WorkOS SDK for Elixir v3.0.1)

Copy Markdown View Source

Operations for the Webhooks API.

Summary

Functions

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

Create a Webhook Endpoint

delete_webhook_endpoint(client, id, opts \\ [])

Delete a Webhook Endpoint

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

List Webhook Endpoints

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

Update a Webhook Endpoint

Functions

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

@spec create_webhook_endpoint(WorkOS.Client.t(), map(), keyword()) ::
  {:ok, WorkOS.WebhookEndpoint.t()} | {:error, WorkOS.Error.error()}

Create a Webhook Endpoint

Create a new webhook endpoint to receive event notifications.

Parameters

delete_webhook_endpoint(client, id, opts \\ [])

@spec delete_webhook_endpoint(WorkOS.Client.t(), String.t(), keyword()) ::
  {:ok, term()} | {:error, WorkOS.Error.error()}

Delete a Webhook Endpoint

Delete an existing webhook endpoint.

Parameters

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

@spec list_webhook_endpoints(WorkOS.Client.t(), map(), keyword()) ::
  {:ok, WorkOS.Page.t(WorkOS.WebhookEndpoint.t())}
  | {:error, WorkOS.Error.error()}

List Webhook Endpoints

Get a list of all of your existing webhook endpoints.

Parameters

  • params — query parameters: :before, :after_, :limit, :order
  • opts — per-request options (see WorkOS.Client.request/5)

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

@spec update_webhook_endpoint(WorkOS.Client.t(), String.t(), map(), keyword()) ::
  {:ok, WorkOS.WebhookEndpoint.t()} | {:error, WorkOS.Error.error()}

Update a Webhook Endpoint

Update the properties of an existing webhook endpoint.

Parameters

  • id — Unique identifier of the Webhook Endpoint.
  • params — request body map
  • opts — per-request options (see WorkOS.Client.request/5)