View Source StepFlow.NotificationHooks.NotificationEndpoints (StepFlow v1.8.0)
The Notification endpoints context.
Summary
Functions
Returns an %Ecto.Changeset{}
for tracking notification_endpoint changes.
Creates a notification_endpoint.
Deletes a NotificationEndpoint.
Gets a single notification_endpoint.
Gets a single notification_endpoint by endpoint_placeholder.
Returns the list of notification endpoints.
Functions
Returns an %Ecto.Changeset{}
for tracking notification_endpoint changes.
Examples
iex> change_notification_endpoint(notification_endpoint)
%Ecto.Changeset{source: %NotificationEndpoint{}}
Creates a notification_endpoint.
Examples
iex> create_notification_endpoint(%
{
endpoint_placeholder: endpoint_placeholder_value,
endpoint_url: endpoint_url_value,
endpoint_credentials (optional): "username:password"
})
{:ok, %NotificationEndpoint{}}
iex> create_notification_endpoint(%
{
endpoint_placeholder: bad_endpoint_placeholder_value,
endpoint_url: endpoint_url_value,
endpoint_credentials (optional): "username:password"
})
{:error, %Ecto.Changeset{}}
Deletes a NotificationEndpoint.
Examples
iex> delete_notification_endpoint(notification_endpoint)
{:ok, %NotificationEndpoint{}}
iex> delete_notification_endpoint(notification_endpoint)
{:error, %Ecto.Changeset{}}
Gets a single notification_endpoint.
Raises Ecto.NoResultsError
if the notification_endpoint does not exist.
Examples
iex> get_notification_endpoint!(123)
%NotificationEndpoint{}
iex> get_notification_endpoint!(456)
** (Ecto.NoResultsError)
Gets a single notification_endpoint by endpoint_placeholder.
Examples
iex> get_notification_endpoint_by_placeholder("MY_PLACEHOLDER")
%NotificationEndpoint{}
iex> get_notification_endpoint_by_placeholder("BAD_PLACEHOLDER")
nil
Returns the list of notification endpoints.
Examples
iex> list_notification_endpoints()
[%NotificationEndpoint{}, ...]