Tools
We provide a variety of tools to help with building your configuration, testing cards, operations, and account security.
Configuration
SDK request debugger
View recent client API requests, to help with debugging your SDK integration. The last 100 failed client API requests are presented.
By default the JWT claims captured for invalid tokens are limited, you can capture and display all claims by enabling an organization preference.
Analytics debugger
View analytics events received by the Atomic Platform, to help debug any issues. The latest events can be viewed or downloaded.
You can find more details about these analytics in the Analytics reference guide.
The card response data payload is only available via the analytics API endpoints. The workbench analytics debugger screen will not include any card response data. This is done to prevent potential customer personally identifiable information (PII) being exposed in the workbench.
Response payload can be toggled on/off in the API endpoints by changing your environment preferences (manage -> Environment -> select overflow -> edit preferences).
Testing
Test Action Flow sender
Use the Action Flow sender to batch and send test cards to test accounts with Action Flows.
When you create a manual JSON object or upload a CSV file containing non-test accounts, the tool will return a success message when you send the request. This means the request has a valid format. The Action Flow instances will only be created for test accounts. Any non-test customers included in the target parameters, will be ignored.
JSON - manual entry
The manual entry uses a similar shape to our API requests, with the addition of the Action Flow configuration id to target. Learn more about this format and other API options in the Action Flow API guide.
Customers need to be pre-configured as test accounts in the Workbench before they can receive test cards.
CSV
Within the file template, we use dot notation to build the payload into JSON format behind the scenes.
You can locate a template file to add your payload detail to in the Workbench: Tools > Testing > Action Flow sender > Sample CSV file.
Within the csv file, each row sends one version of the card with a specific set of variables to the designated user(s). For example, one row can contain multiple customers.
Not all of the columns in the csv file are mandatory - read more about which properties are required and which are optional in the Action Flow API guide.
Batch uploading of test Action Flows is available to Workbench members with access to the 'Card Template' resource. Learn more about Team member permissions.
Depending on how you would like to test cards, you may like to have a version of the csv template for each card template, or alternatively use one template for all card templates, and leave unused variable cells empty.
CSV template properties
| Property | Column header | Example value and notes |
|---|---|---|
| Flow Config ID | flowConfigId | abc123 Must match the ID of the Action Flow configuration in the Workbench. |
| User ID | payload.target.usersById | Abc123dEf456ghI Use | to separate users receiving the same Action Flow. Note: Customers need to be pre-configured as test accounts in the Workbench before they can receive test cards. |
| Card Priority | payload.cardOptions.priority | 5 Learn more about using priority, at Prioritisation. |
| Card Expiry | payload.cardOptions.expires | 2020-12-15T16:47:00+13 Learn more about using expires, including some examples in our Date and Time Reference. |
| Expiry Interval | payload.cardOptions.expiresInterval | PT15M Learn more about using expiresInterval, including some examples in our Date and Time Reference. |
| Card Embargo | payload.cardOptions.embargo | 2020-12-15T16:47:00Z Learn more about using embargo, including some examples in our Date and Time Reference. |
| Flow Invocation ID | flowInvocationId | 1234567890 Can be left blank, in which case Atomic will generate a unique Action Flow invocation ID. It can be any string or number. |
| Card Variable | payload.variables.variableName1 | Jane Must match the name of the variable in Workbench. |
| Card Variable | payload.variables.variableName2 | Smith Must match the name of the variable in Workbench. |
| Metadata | payload.metadata.myProperty1 | EMPLOYEE-123456-abcdef Arbitrary data. Learn more about using metadata in Action Flow API request properties. |
| Metadata | payload.metadata.myProperty2 | uwe421-548efsh-fhdu514 Arbitrary data. Learn more about using metadata in Action Flow API request properties. |
| Notification Detail | payload.notificationDetail.myProperty3 | 1245-jsurbd-54155 Arbitrary data. Learn more about using notification details in Action Flow API request properties. |
Validate auth token
Only workbench members with an view-level permission on the SDK API key resource will be able to use this tool.
Validate that a JWT auth token is valid against one of your API keys.
Operations
Analytics exporter (beta)
View batched analytics files from the past 30 days. Batches are available in JSON, CSV, or Parquet format.
Note that CSV exported content is sanitised as per OWASP guidance.
Read more about these analytics in the Analytics reference guide.
Customer data importer (beta)
Add or update customer profile records by uploading a CSV file. See the Customers guide for a detailed explanation of this tool.
Cancel cards (beta)
Cancel card instances from the Workbench. See the Cancel cards guide for a detailed explanation of this tool.
Action Flow bulk send
Only workbench members with an edit-level permission on the Card instance resource will be able to use this tool.
This tool allows sending Action Flows based on criteria defined in a CSV. You can target users per CSV row by any user profile data.
You can find further information about this tool and download a sample csv file by :
- navigating to the Action Flow bulk send screen (either from the Tools screen or by using the command palette)
- clicking the Information icon next to the "Action Flow bulk send" title in the Workbench.
The only required column in the CSV is at least one 'target.attributes' field, for example 'target.attributes.email'.
Only up-to 10 customers can be matched per row, if more are matched then the row will be skipped and a warning returned.
Security
Audit log (beta)
The Audit log feature is currently in beta. Contact us to provide feedback.
This tool allows you to view workbench members' activity across Atomic. It includes information about requests in the workbench from the last 7 days, from the API and from the SDK.
Because the information in the audit log can be sensitive, access is controlled with a specific "Audit log" permission. See the Permissions guide to configure this permission for your workbench members.