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

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 - Customer notifications

• Workflow Interface - Workflow-triggered notifications