CaptainHook.Behaviour behaviour (captain_hook v1.9.0) View Source
Link to this section Summary
Link to this section Callbacks
Specs
create_webhook_endpoint(map()) :: {:ok, CaptainHook.WebhookEndpoints.WebhookEndpoint.t()} | {:error, Ecto.Changeset.t()}
Specs
delete_webhook_endpoint(CaptainHook.WebhookEndpoints.WebhookEndpoint.t()) :: {:ok, CaptainHook.WebhookEndpoints.WebhookEndpoint.t()} | {:error, Ecto.Changeset.t()}
Specs
disable_notification_type( CaptainHook.WebhookEndpoints.WebhookEndpoint.t(), binary() | [binary()] ) :: {:ok, CaptainHook.WebhookEndpoints.WebhookEndpoint.t()} | {:error, Ecto.Changeset.t()}
Specs
enable_notification_type( CaptainHook.WebhookEndpoints.WebhookEndpoint.t(), binary() | [binary()] ) :: {:ok, CaptainHook.WebhookEndpoints.WebhookEndpoint.t()} | {:error, Ecto.Changeset.t()}
Specs
Specs
get_webhook_endpoint(binary(), keyword()) :: CaptainHook.WebhookEndpoints.WebhookEndpoint.t() | nil
Specs
get_webhook_endpoint!(binary(), keyword()) :: CaptainHook.WebhookEndpoints.WebhookEndpoint.t()
Specs
get_webhook_notification(binary(), keyword()) :: CaptainHook.WebhookNotifications.WebhookNotification.t() | nil
Specs
get_webhook_notification!(binary(), keyword()) :: CaptainHook.WebhookNotifications.WebhookNotification.t()
Specs
Specs
list_webhook_endpoints(keyword()) :: [ CaptainHook.WebhookEndpoints.WebhookEndpoint.t() ]
Specs
list_webhook_notifications(keyword()) :: %{ data: [CaptainHook.WebhookNotifications.WebhookNotification.t()], total: integer() }
Specs
notify(binary() | [binary()], boolean(), binary(), map(), keyword()) :: {:ok, CaptainHook.WebhookNotifications.WebhookNotification.t()} | {:error, Ecto.Changeset.t()}
Specs
roll_webhook_endpoint_secret( CaptainHook.WebhookEndpoints.WebhookEndpoint.t(), DateTime.t() ) :: {:ok, Secrets.WebhookEndpointSecret.t()} | {:error, Ecto.Changeset.t()}
Specs
send_webhook_notification( CaptainHook.WebhookEndpoints.WebhookEndpoint.t(), CaptainHook.WebhookNotifications.WebhookNotification.t() ) :: {:ok, CaptainHook.WebhoookConversations.WebhookConversation.t()} | {:error, Ecto.Changeset.t()}
Specs
update_webhook_endpoint(CaptainHook.WebhookEndpoints.WebhookEndpoint.t(), map()) :: {:ok, CaptainHook.WebhookEndpoints.WebhookEndpoint.t()} | {:error, Ecto.Changeset.t()}