Skip to main content

Sending cards

Before you start

We highly recommend you complete the Authoring Cards tutorial first. This is not strictly required, as we’ll show you where to find preloaded card templates you can use to send directly from the workbench.

Overview

There are three ways to send cards to your customers using Atomic:

  • Directly from the 'Customers' section in the Workbench.
  • Using segment triggers.
  • Using the Atomic 'Action Flow' API endpoint.

Each of these methods is outlined below.

Read the Advanced guide to sending cards if you want to learn more about adding card delivery options to the request payload when using one of the API endpoints.

Sending cards from the workbench

  1. To explore sending cards, we suggest working in your 'Sandbox' environment.

Switch between environments by selecting the environment switcher in the top left:

env_switcher.jpg

  1. Navigate to the Customers section of the workbench:

customers-home.png

In this screen you can select which customers you’d like to send a card to:

One, multiple or all customers

  1. Select the checkboxes next to the customers.
  2. Select 'Send card to [n] customers' button.
  3. In the dropdown, select the card you wish to send and the stream(s) you wish to send it to.
  4. Optional: click on 'Advanced' to see additional delivery options. These are explained in detail in the Delivery options section of the advanced Sending Cards guide. Settings in this modal override the settings in the card builder delivery tab.
  5. Select the 'Send' button.

A segment of customers

  1. Select the Segment from the pre-configured segments.
  2. Select the 'select all' checkbox.
  3. Select 'Send card to [n] customers' button.
  4. In the dropdown, select the card you wish to send and the stream(s) you wish to send it to.
  5. Optional: click on 'Advanced' to see additional delivery options. These are explained in detail in the Delivery options section of the advanced Sending Cards guide.
  6. Select the 'Send' button.
Learn more

Read more more about creating segments in the segment section of our Customers guide.

Segment triggers

You can send cards when customers enter or exit a segment, by adding a segment trigger to a card.

Some considerations when using segment triggers
  • When you add a segment trigger to a card template and then proceed to publish that template, you will send that card to all people meeting the segment trigger conditions. In this scenario, clicking the 'Publish' button in the card template is the same as clicking 'Send card' in the Customers screen.
  • It is possible to specifically include or exclude customers already meeting segment trigger conditions in the 'Publish card' window. Read more in the section Publish a card with segment triggers below.
  • When a customer exits a segment and then re-enters, they will be sent the same card again as long as the on-segment-entry trigger is associated with the card.

Add segment triggers to a card

First you need to make sure you have set up your segments - the segment section of our Customers guide provides details on how to do this.

  1. From the 'Cards' list, select the card you want to add a trigger to. Alternatively, open the command palette and type (parts of) the name of the card.
  2. In the card editor, select the 'triggers' tab of the card you want to add a trigger to.

  1. Click 'add segment trigger' in the Segment triggers section.
  2. Select the segment, and select whether the card needs to be sent on segment entry or segment exit.

You can create multiple triggers, each associated with a different segment.

Publish a card with segment triggers

  1. From the 'Cards' list, select the card you want to add a trigger to. Alternatively, open the command palette and type (parts of) the name of the card.
  2. In the card editor, click the 'Publish' button.
  3. A 'Publish card' window opens with an overview of the card delivery settings once you click 'Publish now' as shown in the screenshot below.

publish-card-modal.png

  1. For every segment entry trigger, it is possible to tick (or untick) the checkbox 'Send to customers already in this segment'.
  2. Once you have configured all settings as required, you can select 'Publish now'.

The card template will be saved as a published version. From the moment it is published, it will be sent to all customers that meet the segment trigger conditions.

Things to know about published cards with segment triggers
  • Once a card with segment triggers is published, the card will be sent out to all customers meeting the segment triggers. The card will continue to be sent to all customers entering (or exiting) the segment, for as long as the card is published (and not expired).
  • It is possible to edit the segments that are used as segment triggers for published cards. You can do this in the Customers screen, but you will get a warning that this might have an impact on new customers entering or exiting the segment (and receiving cards).

Test cards

Watch the video below to learn the basics about sending cards and using the Insights dashboard.

To send a test card to test users, they must be set up with test accounts in the workbench. Every workbench member is set up as a test user, but it is also possible to create additional test accounts.

Add a new test account in the Workbench

In the Workbench, go: Configuration > Testing > Test Accounts, and select 'New test account', and add the necessary details to create a test account:

  • Name: can be anything you choose, e.g. 'test123'
  • User ID: can be anything you choose, as long as it's unique for the environment

Test account permissions

Adding test accounts requires edit permissions on the workbench member resource. See the Permissions resources overview for more information.

Sending test cards from the workbench

Send one-off test cards from the workbench

Unpublished test cards can only be targeted to test Accounts, an unpublished card can never be sent to a live customer.

You can send a test card easily from the Content area of the card by selecting the 'Send test card' icon in the bottom right corner. The test card will work almost identically to a real API event. The main difference is that test cards use the latest content of the card template, including unpublished draft edits, so you can test your un-published work-in-progress card.

Send a batch of test cards

Learn more about the Test Action Flow sender in the Tools guide.

In the Atomic workbench, magic links are available to share access to cards that have been sent to the configured test user (and stream container).

You can view magic links as plain text, or as a QR code for easy scanning with a mobile device.

You can paste a magic link into your iOS or Android Atomic Connect App to open the stream container.

Magic links can be created to view test cards as well as production cards. A workbench user can not create a magic link on behalf of other workbench users.

You can generate magic links using the 'Atomic Connect' button located in the top right corner of the workbench.

Atomic Action Flows

As a first step to unlock the full Action Flow feature set, all cards can now be sent using its API start trigger. This is a URL which can be found in the 'Triggers' tab of the card you want to send.

API-start-trigger.png

Sending test cards using curl

After you have run the authentication sample script, you can send a sample payload to test accounts using its default Action Flow. This is explained in detail in the Action Flow API guide.

Sending cards via its API start trigger using curl

After you have run the authentication sample script, you can send a payload using its default Action Flow. This is explained in detail in the Action Flow API guide.

Sending (test) cards using Insomnia

Setting up Insomnia

Setting up and using Insomnia to send API requests to the Action Flow endpoint is described in the Using Insomania guide. It also includes a link to import the Atomic Swagger Collection, which gives you access to all public API endpoints.

A similar request to the 'Action Flow' endpoint and its response when using Insomnia looks like this:

API-via-Insomnia.png