Zazu.WebhookEndpoints (zazu v0.2.1)

Copy Markdown View Source

Webhook endpoint management.

Summary

Functions

Calls POST /api/webhook_endpoints.

Calls DELETE /api/webhook_endpoints/:id.

Calls POST /api/webhook_endpoints/:id/disable.

Calls POST /api/webhook_endpoints/:id/enable.

Calls GET /api/webhook_endpoints/:id.

Calls GET /api/webhook_endpoints.

Calls POST /api/webhook_endpoints/:id/regenerate_secret.

Calls POST /api/webhook_endpoints/:id/test.

Calls PATCH /api/webhook_endpoints/:id.

Functions

create(client, attributes)

@spec create(Zazu.Client.t(), map()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls POST /api/webhook_endpoints.

delete(client, id)

@spec delete(Zazu.Client.t(), String.t()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls DELETE /api/webhook_endpoints/:id.

disable(client, id)

@spec disable(Zazu.Client.t(), String.t()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls POST /api/webhook_endpoints/:id/disable.

enable(client, id)

@spec enable(Zazu.Client.t(), String.t()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls POST /api/webhook_endpoints/:id/enable.

get(client, id)

@spec get(Zazu.Client.t(), String.t()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls GET /api/webhook_endpoints/:id.

list(client, opts \\ [])

@spec list(
  Zazu.Client.t(),
  keyword()
) :: {:ok, Zazu.Page.t()} | {:error, Exception.t()}

Calls GET /api/webhook_endpoints.

Options

  • :limit — page size (1..100, default 100).
  • :cursor — pagination cursor.

regenerate_secret(client, id)

@spec regenerate_secret(Zazu.Client.t(), String.t()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls POST /api/webhook_endpoints/:id/regenerate_secret.

test(client, id)

@spec test(Zazu.Client.t(), String.t()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls POST /api/webhook_endpoints/:id/test.

update(client, id, attributes)

@spec update(Zazu.Client.t(), String.t(), map()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls PATCH /api/webhook_endpoints/:id.