Skip to content

Commit

Permalink
chore(kno-7612): update all manage template settings references (#750)
Browse files Browse the repository at this point in the history
* Update all manage template settings references to align with current UI

* Update image with reference to manage template settings

* Fix image sizing

* Update with larger image for better clarity
  • Loading branch information
rachael-t authored Jan 17, 2025
1 parent 0c55de1 commit 3f4ad96
Show file tree
Hide file tree
Showing 10 changed files with 25 additions and 13 deletions.
2 changes: 1 addition & 1 deletion content/integrations/email/attachments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ layout: integrations

## How attachments work in Knock

1. Set an attachment key in your email template to tell Knock how to resolve attachments you send in the data payload of your trigger call. To set an attachment key, click the "Manage template settings" menu in the top right corner of the email template editor and set it under the "Attachment key" field.
1. Set an attachment key in your email template to tell Knock how to resolve attachments you send in the data payload of your trigger call. To set an attachment key, click the "Template settings" button in the top right corner of the email template editor and set it under the "Attachment key" field.
2. Include one or more attachment objects in the `data` payload of your trigger call. Each attachment object should have the content of the file to be attached as a base64 encoded value.
3. Knock automatically adds any attachments included in the attachment key of your trigger call to the emails sent by your email provider 🎉.

Expand Down
2 changes: 1 addition & 1 deletion content/integrations/email/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When you configure a setting in a channel's configuration, it will be used on al
You can override email settings on a per-channel basis, or on a per-template basis.

- **At the channel level**. The `to`, `cc`, `bcc`, and `reply-to` fields can be found in the "Overrides" section of the channel's "Settings" tab.
- **At the template level**. You'll find the email settings under the "Manage template settings" button.
- **At the template level**. You'll find the email settings under the "Template settings" button.

All email configuration fields support Liquid usage. You will be able to use any variables available in your workflow trigger payloads, as well as system variables such as the current workflow, activities, and any other variables you have access to when building templates.

Expand Down
4 changes: 2 additions & 2 deletions content/integrations/push/apns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,13 @@ When sending a notification to APNS, we also pass through the following attribut

## Silent/background notifications

We support sending [APNS notifications as "silent", data-only notifications](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app) within Knock. You can enable this per push notification template by clicking "Manage template settings" in the header of the template editor.
We support sending [APNS notifications as "silent", data-only notifications](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app) within Knock. You can enable this per push notification template by clicking "Template settings" in the header of the template editor.

When silent push is enabled, we'll no longer pass through the content payload and your message will be sent with the `content-available: 1` flag as expected by APNS. All properties in the data payload described above will be sent with your notification.

## Using overrides to customize notifications

We have full support for overriding the payload sent to APNS for adding things like badge counts, extra data properties, and sound files. You can set push overrides on the template settings modal, which is accessed by clicking on the "Manage template settings" button when viewing a push notification template within the workflow editor. Push overrides support Liquid for injecting `data` properties and referencing attributes on your recipients.
We have full support for overriding the payload sent to APNS for adding things like badge counts, extra data properties, and sound files. You can set push overrides on the template settings modal, which is accessed by clicking on the "Template settings" button when viewing a push notification template within the workflow editor. Push overrides support Liquid for injecting `data` properties and referencing attributes on your recipients.

Overrides are merged into the notification payload sent to APNS. See the <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification" target="_blank">APNS documentation for more details</a>.

Expand Down
4 changes: 2 additions & 2 deletions content/integrations/push/expo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ When sending a notification to Expo, we also pass through the following attribut

## Silent/background notifications

We support sending Expo notifications as "silent," data-only notifications within Knock. You can enable this per push notification template by clicking "Manage template settings" in the header of the template editor.
We support sending Expo notifications as "silent," data-only notifications within Knock. You can enable this per push notification template by clicking "Template settings" in the header of the template editor.

When silent push is enabled, we'll no longer pass through the content payload and your message will be sent with the `content-available: true` flag as expected by Expo. All properties in the data payload described above will be sent with your notification.

## Using overrides to customize notifications

We have full support for overriding the payload sent to Expo for adding things like badge counts, extra data properties, and sound files. You can set push overrides on the template settings modal, which is accessed by clicking on the "Manage template settings" button when viewing a push notification template within the workflow editor. Push overrides support Liquid for injecting `data` properties and referencing attributes on your recipients.
We have full support for overriding the payload sent to Expo for adding things like badge counts, extra data properties, and sound files. You can set push overrides on the template settings modal, which is accessed by clicking on the "Template settings" button when viewing a push notification template within the workflow editor. Push overrides support Liquid for injecting `data` properties and referencing attributes on your recipients.

Overrides are merged into the notification payload sent to Expo. See the <a href="https://docs.expo.dev/push-notifications/sending-notifications/#message-request-format" target="_blank">Expo documentation for more details</a>.

Expand Down
4 changes: 2 additions & 2 deletions content/integrations/push/firebase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@ becomes

## Silent/data notifications

We support sending [FCM notifications as "silent," data-only notifications](https://firebase.google.com/docs/cloud-messaging/concept-options#data_messages) within Knock. You can enable this per push notification template by clicking "Manage template settings" in the header of the template editor.
We support sending [FCM notifications as "silent," data-only notifications](https://firebase.google.com/docs/cloud-messaging/concept-options#data_messages) within Knock. You can enable this per push notification template by clicking "Template settings" in the header of the template editor.

When silent push is enabled, we'll no longer pass through the message payload. All properties in the data payload described above will be sent with your notification still.

## Using overrides to customize notifications

We have full support for overriding the payload sent to FCM for adding things like badge counts, extra data properties, and sound files. You can set push overrides on the template settings modal, which is accessed by clicking on the "Manage template settings" button when viewing a push notification template within the workflow editor. Push overrides support Liquid for injecting `data` properties and referencing attributes on your recipients.
We have full support for overriding the payload sent to FCM for adding things like badge counts, extra data properties, and sound files. You can set push overrides on the template settings modal, which is accessed by clicking on the "Template settings" button when viewing a push notification template within the workflow editor. Push overrides support Liquid for injecting `data` properties and referencing attributes on your recipients.

By default, payload overrides will be merged into the base `data` and will not replace other trigger `data` being passed to FCM. The override also needs to match the format that is expected by FCM, meaning that any custom key-value pairs should be contained inside of a `data` dictionary:

Expand Down
4 changes: 2 additions & 2 deletions content/integrations/push/one-signal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ When sending a push notification to OneSignal, we will automatically pass the fo

## Silent/background notifications

When selecting to send as a silent/background notification, Knock will passthrough the content_available=true option to OneSignal. You can enable this per push notification template by clicking "Manage template settings" in the header of the template editor.
When selecting to send as a silent/background notification, Knock will passthrough the content_available=true option to OneSignal. You can enable this per push notification template by clicking "Template settings" in the header of the template editor.

## Using overrides to customize notifications

We have full support for overriding the payload sent to OneSignal for adding things like badge counts, extra data properties, and sound files. You can set push overrides on the template settings modal, which is accessed by clicking on the "Manage template settings" button when viewing a push notification template within the workflow editor. Push overrides support Liquid for injecting `data` properties and referencing attributes on your recipients.
We have full support for overriding the payload sent to OneSignal for adding things like badge counts, extra data properties, and sound files. You can set push overrides on the template settings modal, which is accessed by clicking on the "Template settings" button when viewing a push notification template within the workflow editor. Push overrides support Liquid for injecting `data` properties and referencing attributes on your recipients.

Overrides are merged into the notification payload sent to OneSignal. See the <a href="https://documentation.onesignal.com/reference/push-notification" target="_blank">OneSignal documentation for more details</a>. Knock uses the "Aliases" targeting strategy to send push notifications to specific users via External ID.

Expand Down
2 changes: 1 addition & 1 deletion content/integrations/push/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Channel groups are currently enabled on an on-demand basis. If you'd like it ena

## Push overrides

For push-specific sending needs, a set of overrides can be set per template from the "Manage template settings" button on the push message template page. The overrides provided are merged into the push payload sent to the underlying provider and can be used to set badge counts, custom sound files, and any other provider-specific settings.
For push-specific sending needs, a set of overrides can be set per template from the "Template settings" button on the push message template page. The overrides provided are merged into the push payload sent to the underlying provider and can be used to set badge counts, custom sound files, and any other provider-specific settings.

By default, all overrides are applied with a `merge` strategy, which can be customized by adding a `__strategy__` key to the top level of the JSON payload and setting as `replace`. When the strategy is set to replace, all existing properties will be overridden with what's included in the overrides JSON.

Expand Down
8 changes: 7 additions & 1 deletion content/sdks/android/deep-links.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@ section: SDKs
- In your message payload that you send to Knock, include a property with a value of your deep link. The name of the property doesn't matter, so long as you know beforehand what it will be called.
- This can also be done in your Knock Dashboard in your [Payload overrides](/integrations/push/overview#push-overrides).

![Deep link payload override](/images/deep-link-payload-override.png)
<Image
src="/images/deep-link-payload-override.png"
alt="Deep link payload override"
className="rounded-md mx-auto border border-gray-200"
width={500}
height={507}
/>

## 3. Handle Incoming URLs:

Expand Down
8 changes: 7 additions & 1 deletion content/sdks/ios/deep-links.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ section: SDKs
- In your message payload that you send to Knock, include a property with a value of your deep link. The name of the property doesn't matter, so long as you know beforehand what it will be called.
- This can also be done in your Knock Dashboard in your [Payload overrides](/integrations/push/overview#push-overrides).

![Deep link payload override](/images/deep-link-payload-override.png)
<Image
src="/images/deep-link-payload-override.png"
alt="Deep link payload override"
className="rounded-md mx-auto border border-gray-200"
width={500}
height={507}
/>

## 3. Handle Incoming URLs:

Expand Down
Binary file modified public/images/deep-link-payload-override.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3f4ad96

Please sign in to comment.