Lettermint.Webhooks (Lettermint v2.1.0)

Webhook endpoints. Needs :team_token. Delivery attempts are in Lettermint.Webhooks.Deliveries. To verify incoming deliveries, use Lettermint.Webhook.

Every function takes the options timeout: (milliseconds) last.

Summary

Types

result(value)

Functions

create(client, body, options \\ [])

Creates a webhook. The response holds its signing secret once.

delete(client, webhook_id, options \\ [])

Deletes a webhook.

iterate(client, query \\ %{}, options \\ [])

Streams every webhook, following next_cursor. Raises the error of a failed page request.

list(client, query \\ %{}, options \\ [])

Lists webhooks, one page at a time. query: Lettermint.Types.ListWebhooksQuery.t/0.

regenerate_secret(client, webhook_id, options \\ [])

Replaces the signing secret. The response holds the new secret once.

retrieve(client, webhook_id, options \\ [])

Retrieves a webhook.

test(client, webhook_id, options \\ [])

Sends a webhook.test delivery.

update(client, webhook_id, body, options \\ [])

Updates a webhook.

Types

result(value)

@type result(value) :: {:ok, value} | {:error, Lettermint.Error.t()}

Functions

create(client, body, options \\ [])

@spec create(
  Lettermint.Client.t(),
  Lettermint.Types.StoreWebhookData.t() | map(),
  keyword()
) ::
  result(Lettermint.Types.WebhookSecretResponse.t())

Creates a webhook. The response holds its signing secret once.

delete(client, webhook_id, options \\ [])

@spec delete(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.MessageResponse.t())

Deletes a webhook.

iterate(client, query \\ %{}, options \\ [])

@spec iterate(
  Lettermint.Client.t(),
  Lettermint.Types.ListWebhooksQuery.t(),
  keyword()
) ::
  Enumerable.t(Lettermint.Types.WebhookListData.t())

Streams every webhook, following next_cursor. Raises the error of a failed page request.

list(client, query \\ %{}, options \\ [])

@spec list(Lettermint.Client.t(), Lettermint.Types.ListWebhooksQuery.t(), keyword()) ::
  result(Lettermint.Types.ListWebhooksResponse.t())

Lists webhooks, one page at a time. query: Lettermint.Types.ListWebhooksQuery.t/0.

regenerate_secret(client, webhook_id, options \\ [])

@spec regenerate_secret(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.WebhookSecretResponse.t())

Replaces the signing secret. The response holds the new secret once.

retrieve(client, webhook_id, options \\ [])

@spec retrieve(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.WebhookData.t())

Retrieves a webhook.

test(client, webhook_id, options \\ [])

@spec test(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.TestWebhookResponse.t())

Sends a webhook.test delivery.

update(client, webhook_id, body, options \\ [])

@spec update(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.UpdateWebhookData.t() | map(),
  keyword()
) :: result(Lettermint.Types.WebhookMutationResponse.t())

Updates a webhook.