Snippets

A single snippet can be used in multiple channels. Snippets support text or HTML content and can be used for commonly used elements such as a copyright, header image, or custom CSS.

About snippets

When you edit a snippet, the changes automatically update anywhere that snippet is in use. For scheduled and recurring messages, resave the message to update the message with the latest version of the snippet. Example uses:

• Company branding — Create an HTML snippet with your company’s colors. When the colors need to be updated, edit the hex values in the snippet.
• Header and footer blocks — Create HTML snippets for the headers and footers you use for messages across different channels.
• Streamline inserting external data feedsA connection to an external API. When you send a message, Airship uses a response from that API to personalize messages. — Create a snippet that references an external data feed. Instead of using the longer format and process used to insert a feed, use the shorter snippet format: {{>snippet_ID}}.

You create snippets in the dashboard, and you can insert them into your messages and templates using both the dashboard and API. You can assign keywords to your snippets so they are easily found in search.

Snippet format

A snippet has three parts:

• Name — Used for identification in the list of all snippets in your project.
• ID — Used to reference the snippet in your message. The snippet ID is generated automatically based on the snippet name, though you have the option to change it.
• Content — The text or HTML that is inserted in your message where the snippet is referenced.

Personalizing snippets

You can use HandlebarsHandlebars is Airship’s templating language for personalization. Handlebars expressions use double curly braces wrapped around a content template, ranging from a simple variable, e.g., {{first_name}}, to complex evaluations of personalization data. and external data feedsA connection to an external API. When you send a message, Airship uses a response from that API to personalize messages. to insert merge fieldsA variable in your message or template that you want to populate with a personalized value for each member of the audience. Merge fields use Handlebars syntax: {{merge_field}}. and dynamic contentVariable message content created using Handlebars syntax. The content is populated at send time, resulting in personalized messaging for each member of your audience. to personalize messages for each individual member of your audience. The dashboard supports previewing content that contains Handlebars. See Previewing personalized content.

You can also pass template variables into a snippet to customize it for a specific message. For example, you might set up a “footer” snippet with a dynamic URL as its content like this:

<a href="https://example.com?utm_source={{utm_source}}&utm_campaign={{utm_campaign}}">

When including the snippet in your message, you can pass in one or more of the variables. You would add the snippet to your message text like this:

{{>footer utm_source="email" utm_campaign="newsletter"}}

Create a snippet

You can create a maximum of 1,000 snippets per project.

1. Go to Content and select Snippets.
2. Select Create snippet.
3. Enter a name and description for the snippet. The snippet ID is automatically generated based on the name.
   • A snippet ID will not generate for a snippet name that contains only numbers and/or special characters.
   • If the name starts with a number and/or special characters, the generated ID omits the leading numbers and/or special characters.
   • Uppercase letters in the name are converted to lowercase in the ID.
   • Special characters in the name are converted to underscores in the ID and only appear if followed by numbers or letters.
4. (Optional) Edit the snippet ID. Letters, numbers, and underscores only, and must start with a letter and end with a letter or number. You cannot change the snippet ID later.
5. (Optional) Add keywords to help organize your snippets. Enter a term in the search field and select from results, or select Add keyword: [term]. You can add up to 10 keywords.
6. Select Continue.
7. Add your plain text and/or HTML content.
   1. Select Add .
   2. Enter your content. The preview updates as you type.
      Important

      Do not insert a snippet into another snippet.

   3. Select Done.
8. Select Save snippet when you are done adding content.

Insert a snippet

You can insert a snippet anywhere that supports HandlebarsHandlebars is Airship’s templating language for personalization. Handlebars expressions use double curly braces wrapped around a content template, ranging from a simple variable, e.g., {{first_name}}, to complex evaluations of personalization data. by entering its ID in the format {{>snippet_ID}}. To get the ID, go to Content, then Snippet, select the more menu icon () for a snippet, then Copy ID to clipboard.

When using the Interactive editor and pasting or uploading HTML, a snippet is immediately rendered in the preview. If using layouts, you can insert snippets into text or HTML content, but they will not render in the editor. You must select Done to see the preview.

To include a snippet in an API request, reference the snippet by name in the snippet_references object, and invoke the snippet in your notification text. The example below loads a “signature” snippet and adds it to the end of the message.

POST /attachments HTTP/1.1
Authorization: Bearer <authorization token>
Content-Type: application/json
Accept: application/vnd.urbanairship+json; version=3

{
   "notification": {
      "alert": "Hi {{ name }}: Thanks for your purchase! {{> signature }}"
   },
   "snippet_references": {
      "snippets": [
         {
            "name": "signature"
         }
      ]
   }
}

See Snippet references object in our API reference for details.

Managing snippets

Go to Content and select Snippets to view the list of snippets in your project. You can search by name, ID, or keyword. Snippets that are used in template content are labeled “In use”.

You can manage snippets from two locations:

• More menu — Select the more menu icon () for a snippet for the options to edit, duplicate, add to a CampaignA container for organizing and coordinating related messages across channels. They provide message list and calendar views to monitor status, spot scheduling gaps, and avoid overlap., or delete. Deleting a snippet that is in use may impact messaging.

• Drawer — Select View detail from the more menu, or select the snippet name, to open a drawer with the same edit and duplicate options as in the more menu, plus the ability to change its name, description, and keywords, and manage its associated Campaigns. The drawer also displays the external data feedsA connection to an external API. When you send a message, Airship uses a response from that API to personalize messages. used in the snippet and any templates that reference it.

Duplicating makes a copy of the snippet in the current project or in a different project.

To manage keywords for multiple snippets at once, select them in the list, then select Actions, and then Manage keywords.