Custom Transport Modes

When content is published and distributed to recipients, it becomes accessible through the web application and can also trigger desktop notifications. Additionally, it can be disseminated to users via various communication methods, including Text Messages (SMS), Emails, or Mobile Push Notifications. In Heed, these communication methods are referred to as "Transport Modes." There may be instances where you need to create custom transport modes, such as when you want to utilize your own SMS provider or send notifications to a specific API or another application.

A custom transport mode essentially functions as a workflow that is triggered whenever a Heed message is sent or updated. This workflow is activated with the following data:

1. Subject: The subject of the Heed message.
2. Body: The content of the Heed message.
3. Attributes: An array containing custom attributes and their corresponding values.
4. Recipients: An object that includes the following arrays:
   1. Users: A list of users selected as recipients.
   2. Channels: The list of channels to which the Heed message has been sent.
   3. Combined: A derived list of users obtained from the selected users and channel members.
      
      

When enabled, the custom transport mode will be visible to users within their Heed Preferences page, specifically for each of their Heed message types. Users can configure their preferences for how they wish to receive these customized notifications.

Creating a new Transport Mode

To create a new custom transport mode, follow these steps:

1. Navigate to the Apps page in the Heed Admin Portal.
2. Open the App that you wish to add the custom transport mode to by clicking on the edit pencil.
   
   
   
3. Then, select the Transport Modes menu item.
   
   
   
4. Click Create Transport Mode. 
5. Enter a name for your transport mode and then click Create.
   
   
   
6. Once created, your transport mode will show in the list as disabled, you can enable it by clicking the shield button next to the transport mode.
   
   To start building your transport mode, click on the designer button to open the editor.