Atlas

Atlas Help Center

New Ticket

Atlas provides a straightforward way to access our APIs, allowing you to integrate our functionality into your own systems. This guide will show you how to obtain your API token and make your first API call.

To get started with the API, you'll need to retrieve your API token. Go to 

As soon as you land on this page, you'll see your API token. You can view and copy this token for use in your API calls. It's important to keep this token secure, as it provides access to your Atlas data.

. Once you have your token, you're ready to make API calls. Here's a simple process to test an API:

When you make the call, you should receive a response. If you get a successful response, it means your token is valid for that particular call.

With your token validated, you can now use it to make various API calls to interact with your Atlas data. This could include retrieving customer information, updating conversations, or any other actions supported by our API.

Remember, each API call will require your token for authentication, ensuring that only authorized users can access your data.

If you encounter any issues or have questions about specific API endpoints, don't hesitate to consult our detailed API documentation or reach out to our support team.

Easily integrate Atlas with your systems using our custom data APIs. Let's walk through how to set up and use the API.

Webhooks in Atlas are events that we fire to a specific URL whenever there's a change in the system. This feature is particularly useful for customers who want to keep track of information sent to agents and monitor agent ratings in real-time.

”.* Choose which type of event you want to monitor. Atlas offers a variety of event types, including:

Linking or unlinking a customer from an account

The most commonly used events are typically:

Many of our customers use the "conversation created" and "new message received" events to closely monitor agent performance and identify areas where customer queries are most frequent.

Once you've chosen your event type, you'll need to provide a URL where Atlas will send the webhook data. This URL should be capable of receiving and processing the incoming data.

For security purposes, all data sent to your webhook is encoded using a secret key. This is crucial because webhooks are often public APIs, making data verification important.

You can use your specific secret key to verify the incoming data. If you believe your secret key has been compromised, you have the option to rotate it for enhanced security.

After setting up your webhook, it's a good idea to test it to ensure it's working correctly. Here's an example of how you might test a webhook for tag changes:

Set up a webhook for the "conversation status changed" event.

Go to a conversation in Atlas and add or change a tag.

Check your webhook endpoint. You should receive complete data about the conversation, including the new tags that were changed.

This allows your team to track which tags were modified and when, providing valuable insights into conversation categorization and workflow.

Webhooks can be incredibly useful for various purposes. For instance, they allow you to:

Integrate Atlas data with other systems in your tech stack

Automate responses or actions based on specific events

API & Web hooks