> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/interfaces/notifiable.md).

# Notifiable

Interface for entities that can send notifications

Audience: Programmer

The `Notifiable` interface is implemented by entities that can trigger notifications through various channels like email, SMS, webhooks, or in-app messages.

## Fields

| Field                  | Type                     | Description                       |
| ---------------------- | ------------------------ | --------------------------------- |
| `notificationSettings` | `NotificationSettings`   | Configuration for notifications   |
| `notificationHistory`  | `NotificationConnection` | Past notifications                |
| `canNotify`            | `Boolean!`               | Whether notifications are enabled |

## Notification Channels

* **Email** - SMTP email notifications
* **SMS** - Text message alerts
* **Webhook** - HTTP callbacks
* **In-App** - Application notifications
* **Push** - Mobile push notifications

## Implementing Types

* PickingOrder (order ready, shipped)
* ReceivingInbound (arrival notice, completed)
* InventoryItem (low stock, expiry)
* Customer (order updates)
* Supplier (PO sent, delivery request)

## Usage

```graphql
query {
  pickingOrder(id: "123") {
    ... on Notifiable {
      canNotify
      notificationSettings {
        emailEnabled
        smsEnabled
        webhookEnabled
        recipients
      }
      notificationHistory(first: 10) {
        edges {
          node {
            id
            channel
            status
            sentAt
            message
          }
        }
      }
    }
  }
}

mutation {
  sendNotification(input: {
    entityID: "123"
    entityType: "PickingOrder"
    channel: EMAIL
    template: "order_shipped"
    data: {
      trackingNumber: "1Z999AA1"
    }
  }) {
    notification {
      id
      status
    }
  }
}
```

## Notification Events

Common trigger events:

* Status changes
* Threshold breaches
* Workflow completions
* Error conditions
* Scheduled reminders

## Templates

Notifications use templates with:

* Variable substitution
* Multi-language support
* HTML/Text formats
* Custom branding
* Dynamic content

## Best Practices

1. Implement notification preferences
2. Batch notifications when possible
3. Track delivery status
4. Handle bounces and failures
5. Respect opt-out preferences
6. Rate limit notifications

## See Also

* [Customer Type](/graphql-api/types/customer.md) - Customer notifications
* [Workflow Interface](/graphql-api/interfaces/withworkflows.md) - Workflow-triggered notifications


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/interfaces/notifiable.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.