@spec create_webhook1(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Create a webhook — Create a webhook

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec create_webhook1!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like create_webhook1/2 but returns the value directly and raises on error.

@spec delete_webhook(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Delete a webhook — Delete a webhook

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec delete_webhook!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like delete_webhook/3 but returns the value directly and raises on error.

@spec get_event(Synctera.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get webhook event — Get webhook event by ID

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_event!(Synctera.Client.t(), String.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_event/4 but returns the value directly and raises on error.

@spec get_webhook1(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get a webhook — Get a webhook

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_webhook1!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_webhook1/3 but returns the value directly and raises on error.

@spec list_events(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List webhook events — List webhook events. This response will not associate with the event response history.

Options

Query options: :start_date, :end_date, :start_time, :end_time, :limit, :page_token

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_events!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()

Like list_events/3 but returns the value directly and raises on error.

@spec list_webhooks1(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List webhooks — List all webhooks

Options

Query options: :limit, :page_token, :is_enabled_only

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_webhooks1!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_webhooks1/2 but returns the value directly and raises on error.

@spec resend_event(Synctera.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Resend an event — Resend a webhook event

Options

Query options: :delay

• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec resend_event!(Synctera.Client.t(), String.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like resend_event/4 but returns the value directly and raises on error.

@spec trigger_event(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Trigger an event — Trigger an specific event for webhook testing purpose

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec trigger_event!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like trigger_event/2 but returns the value directly and raises on error.

@spec update_webhook(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Update a webhook — Update a webhook

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec update_webhook!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like update_webhook/3 but returns the value directly and raises on error.