CaptainHook.Behaviour behaviour (captain_hook v1.8.0) View Source

Link to this section Summary

Link to this section Callbacks

Link to this callback

create_webhook_endpoint(map)

View Source

Specs

create_webhook_endpoint(map()) ::
  {:ok, CaptainHook.WebhookEndpoints.WebhookEndpoint.t()}
  | {:error, Ecto.Changeset.t()}
Link to this callback

delete_webhook_endpoint(arg1)

View Source

Specs

Link to this callback

disable_notification_type(arg1, arg2)

View Source

Specs

Link to this callback

enable_notification_type(arg1, arg2)

View Source

Specs

Link to this callback

get_webhook_conversation(binary, keyword)

View Source

Specs

get_webhook_conversation(binary(), keyword()) ::
  CaptainHook.WebhoookConversations.WebhookConversation.t() | nil
Link to this callback

get_webhook_endpoint(binary, keyword)

View Source

Specs

get_webhook_endpoint(binary(), keyword()) ::
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t() | nil
Link to this callback

get_webhook_endpoint!(binary, keyword)

View Source

Specs

Link to this callback

get_webhook_notification(binary, keyword)

View Source

Specs

get_webhook_notification(binary(), keyword()) ::
  CaptainHook.WebhookNotifications.WebhookNotification.t() | nil
Link to this callback

get_webhook_notification!(binary, keyword)

View Source

Specs

Link to this callback

list_webhook_conversations(keyword)

View Source

Specs

list_webhook_conversations(keyword()) :: %{
  data: [CaptainHook.WebhoookConversations.WebhookConversation.t()],
  total: integer()
}
Link to this callback

list_webhook_endpoints(keyword)

View Source

Specs

list_webhook_endpoints(keyword()) :: [
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t()
]
Link to this callback

list_webhook_notifications(keyword)

View Source

Specs

list_webhook_notifications(keyword()) :: %{
  data: [CaptainHook.WebhookNotifications.WebhookNotification.t()],
  total: integer()
}
Link to this callback

notify(arg1, boolean, binary, map, keyword)

View Source

Specs

Link to this callback

roll_webhook_endpoint_secret(arg1, arg2)

View Source

Specs

roll_webhook_endpoint_secret(
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t(),
  DateTime.t()
) :: {:ok, Secrets.WebhookEndpointSecret.t()} | {:error, Ecto.Changeset.t()}
Link to this callback

send_webhook_notification(arg1, arg2)

View Source

Specs

send_webhook_notification(
  CaptainHook.WebhookEndpoints.WebhookEndpoint.t(),
  CaptainHook.WebhookNotifications.WebhookNotification.t()
) ::
  {:ok, CaptainHook.WebhoookConversations.WebhookConversation.t()}
  | {:error, Ecto.Changeset.t()}
Link to this callback

update_webhook_endpoint(arg1, map)

View Source

Specs