captain_hook v0.4.1 CaptainHook

Link to this section Summary

Link to this section Functions

Link to this function

create_webhook_endpoint(webhook, attrs)

Specs

create_webhook_endpoint(binary(), map()) ::
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t()

Callback implementation for CaptainHook.Behaviour.create_webhook_endpoint/2.

Link to this function

delete_webhook_endpoint(webhook_endpoint)

Specs

delete_webhook_endpoint(CaptainHook.WebhookEndpoints.WebhookEndpoint.t()) ::
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t()

Callback implementation for CaptainHook.Behaviour.delete_webhook_endpoint/1.

Link to this function

filter_webhook_endpoints(webhook_endpoints, status, datetime)

Specs

filter_webhook_endpoints(
  [CaptainHook.WebhookEndpoints.WebhookEndpoint.t()],
  atom() | [atom()],
  DateTime.t()
) :: [CaptainHook.WebhookEndpoints.WebhookEndpoint.t()]

See CaptainHook.WebhookEndpoints.filter_webhook_endpoints/3.

Link to this function

get_webhook_conversation(webhook, id)

Specs

get_webhook_conversation(binary(), binary()) ::
  CaptainHook.WebhookConversations.WebhookConversation.t()

Callback implementation for CaptainHook.Behaviour.get_webhook_conversation/2.

Link to this function

get_webhook_endpoint(webhook, id)

Specs

get_webhook_endpoint(binary(), binary()) ::
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t()

Callback implementation for CaptainHook.Behaviour.get_webhook_endpoint/2.

Link to this function

get_webhook_endpoint!(webhook, id)

Specs

get_webhook_endpoint!(binary(), binary()) ::
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t()

Callback implementation for CaptainHook.Behaviour.get_webhook_endpoint!/2.

Link to this function

list_webhook_conversations(webhook, param)

Specs

list_webhook_conversations(
  binary(),
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t() | {binary(), binary()}
) :: [CaptainHook.WebhookConversations.WebhookConversation.t()]

Callback implementation for CaptainHook.Behaviour.list_webhook_conversations/2.

Link to this function

list_webhook_endpoints(webhook)

Specs

list_webhook_endpoints(binary()) :: [
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t()
]

Callback implementation for CaptainHook.Behaviour.list_webhook_endpoints/1.

Link to this function

notify(webhook, action, arg, data, opts \\ [])

Specs

notify(binary(), binary(), {atom(), binary()}, map(), keyword()) ::
  :ok | {:error, :no_webhook_endpoint_found}

Callback implementation for CaptainHook.Behaviour.notify/5.

Link to this function

update_webhook_endpoint(webhook_endpoint, attrs)

Specs

update_webhook_endpoint(CaptainHook.WebhookEndpoints.WebhookEndpoint.t(), map()) ::
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t()

Callback implementation for CaptainHook.Behaviour.update_webhook_endpoint/2.