Skip to main content

Atomic API

Overview

The Atomic API allows you to send requests and receive data from the Atomic platform. The primary subresources are:

  • Workbench resources - Manage workbench resources, typically as part of your CD pipeline. Create, update and retrieve card templates.
  • Users - Create, update, view, tag and delete users.
  • Cards - Send test cards, list, dismiss, complete and cancel cards.

In addition to this, Webhooks allow you to receive data back from Atomic.

Open API specification

An Open API specification for the Atomic API is available here:

https://01.customer-api.atomic.io/spec.yaml

This includes documentation on all public API endpoints.

If you want to use a third party tool to interact with the Atomic API, have a look at Using Insomnia. This guide describes how to set up Insomnia, authentication and provides a number of sample requests.

Our documentation also describes how to make requests using the curl command line tool. When using curl, you'll need to set up your Authentication first.

Debugging and troubleshooting cards

We have three tools available within the Workbench to help you debug and troubleshoot integration work.

Analytics debugger

The Analytics debugger will let you inspect the most recent analytics events that happened in your environment.

To access the Analytics debugger, go: Tools > Configuration > Analytics debugger

You can find more details about these analytics in the Analytics reference guide.

Card log

Within the card log you can browse a list of sent cards, and see their current status. The list is paginated.
It’s a lightweight tool to support troubleshooting, rather than analysis.

To access the Card Log, select the card you are troubleshooting, then the ‘Log’ tab.

SDK request debugger

The SDK request debugger shows the last 100 failed client API requests in your organization, to help with debugging your SDK integration.

To access the Request Debugger, go: Tools > Configuration > SDK request debugger

Audit log

The Audit log shows a history of all requests that have been made for the last 7 days to the platform from the SDK and API.

To access the Audit log, go: Tools > Security > Audit log