Commslayer Integration

>
Commslayer Integration

Commslayer Integration Guide

This guide connects a Commslayer account to Agents Only. Steps 1 and 2 happen in Commslayer, steps 3 to 5 in the Agents Only client portal. Once it is wired up, Agents Only reads conversations and messages so agent activity and customer contacts flow into your reporting.

Read this guide online

‍
Before you start: This guide connects a Commslayer account to Agents Only. Steps 1 and 2 happen in Commslayer, steps 3 to 5 in the Agents Only client portal. Once it is wired up, Agents Only reads conversations and messages so agent activity and customer contacts flow into your reporting.

Step 1: Create an integration token in Commslayer

  • In Commslayer, open Settings in the left sidebar, then Integration tokens.
  • Click Create new token, give it a name (for example, “Agents Only”), and select its permissions. Include conversations:read, messages:read, reports:read and webhooks:manage. Agents Only lists your conversations with the first, reads the replies inside them with the second, matches your agents with the third, and verifies your webhook signing secret with the fourth. A token without conversations:read cannot be saved, and the portal will tell you which scope is missing.
  • Copy the token before you close the dialog. Commslayer shows it once and cannot show it again.
  • Reference: https://docs.commslayer.com/en/articles/1779553424-where-to-find-your-api-key-integration-tokens
    ‍

Step 2: Register a webhook that points at Agents Only

  • In Commslayer, go to Settings > Webhooks and create a webhook with this URL: https://api.agentsonly.com/integrations/commslayer
  • Subscribe it to message_created and conversation_status_changed. Both are needed: message_created drives agent productive time, and conversation_status_changed is what tells Agents Only a conversation has been resolved. Without it no contact records are ever created, and reporting stays empty even though the integration still shows as connected. Any other events you tick are accepted and ignored.
  • Copy the signing secret Commslayer issues for the webhook. You need it in step 3.
    ‍

Step 3: Save both values in the Agents Only Client Portal

  • Open the project’s Integration page, select Commslayer, and paste the integration token.
  • Then paste the webhook signing secret, and save. Agents Only stores the secret, asks Commslayer to send a signed test delivery, and reports the result against the field.
  • If you change the secret later, it is checked as soon as you leave the field — no save needed.

4. Verify

Go back to the Commslayer webhook page and press Test. A green result means Commslayer signed the delivery and our receiver accepted the signature. You are done.
‍

5. Map your agents to their Commslayer IDs

Reporting attributes work to whoever sent it, so each agent has to be linked to their Commslayer ID once. Until an agent is mapped, their activity is not counted.

  • Get the agent list from Commslayer. Call GET https://app.commslayer.com/api/integration/v1/reports/agents with your integration token. This is the endpoint the reports:read scope from step 1 unlocks.
  • Each entry carries the agent’s display name and the numeric agent_id you need, for example “agent”: “John Doe” alongside “agent_id”: 15057. The metrics in the same object are not used for mapping.
  • In the Agents Only client portal, go to Agents, select the agent you want to map, and press Training.
  • Paste that agent’s Commslayer ID into the dialog and submit.
  • Check the number before you submit. The field takes a numeric ID, so a mistyped digit can land on a different real agent. Agents Only rejects an ID your account does not know, but it cannot tell that a valid ID is the wrong valid ID.

Troubleshooting

  • The portal says it could not check the secret. Your integration token is probably missing the webhooks:manage permission. The secret itself may be fine — this only means we could not ask Commslayer to test it. Create a replacement token with that permission and save it.
  • The portal says the secret is wrong. The test delivery arrived, but its signature did not match. Re-copy the signing secret from the Commslayer webhook page, or rotate it there and paste the new one.
  • The portal says no webhook is registered. No webhook in your Commslayer account points at the Agents Only URL above. Check that URL in step 2 for typos.
  • You lost the integration token. Tokens cannot be re-displayed. Revoke the old one under Settings and create a replacement.
  • Reporting is empty but the integration is connected. The webhook is probably missing the conversation_status_changed event. Contact records are created when a conversation is resolved, so until that event arrives there is nothing to report. Open the webhook in Commslayer and confirm both events are ticked.

Get started today