# Notifiables

A `Notifiable` is a something that can recieve a notification.  Traditionally it is your `User` object, but it isn't limited to that.  You may send notifications to a `Team`, a `MailingList`, a `Site`, or more.

### INotifiable

A `Notifiable` needs to implement the `INotifiable` interface (`implements` keyword optional).

```cfscript
interface displayName="INotifiable" {

    /**
     * The id representing this notifiable.
     */
    public string function getNotifiableId();

    /**
     * The type name representing this notifiable.
     */
    public string function getNotifiableType();

}
```

An example implementation for a `User` component could be as follows:

```cfscript
component
    name="User"
    accessors="true"
    implements="megaphone.models.Interfaces.INotifiable"
{

    property name="id";
    
    /**
     * The id representing this notifiable.
     */
    public string function getNotifiableId() {
        return getId();
    }

    /**
     * The type name representing this notifiable.
     */
    public string function getNotifiableType() {
        return "user";
    }

}
```

### via

`Notifiable` instances are passed to the `via` method on a `Notification`. This is to allow you to customize the channels used to each `Notifiable`.  You may choose certain channels for a certain `Notifiable` type, like only sending SMS messages to `User` instances, not `Team` instances.  You can also store `Notifiable`-specific configuration, like allowing a `User` to opt-in to certain channels like `sms`, `email`, or `slack`.

{% hint style="info" %}
See the [`via` docs on `Notifications`](/creating-and-sending-notifications/defining-notifications.md#via) for more information.
{% endhint %}

### routeNotificationFor

Providers may look for a `routeNotificationFor` method suffixed with the Provider type name.  For instance, the `EmailProvider` may look for a `routeNotificationForEmail` method on the `Notifiable`. 

{% hint style="info" %}
See the Provider-specific docs for more information.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://megaphone.ortusbooks.com/creating-and-sending-notifications/notifiables.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.