Accessing the 8x8 Contact Center Streaming API Using Postman

Objective

Access the 8x8 Contact Center Streaming API through Postman.

Applies To

• 8x8 Contact Center

• Streaming API

Procedure

Gather Tenant and Token Information

1. Log in to Configuration Manager for Contact Center.

2. Go to Integration > API Token.

3. If no tokens are present, click New Token next to the Data Request Token field. DO NOT RESET the token! 

Subscribe to the Streaming API on POSTMAN

1. Log in to Postman.

2. From the top left, select New.

3. Select WebSocket

4. Use the following URL: wss://tenanturl/api/streaming/v1/clientconnect/subscribe/TenantUpdates-{{tenantname}-cdc_postman?desiredOutputType=JSON&tenantId={{tenantname}}&subsId=cdc_postman&X-Atmosphere-tracking-id=0&X-Atmosphere-Framework=2.3.2-javascript&X-Atmosphere-Transport=websocket&X-atmo-protocol=true

   
   Example: wss://vcc-na3.8x8.com/api/streaming/v1/clientconnect/subscribe/TenantUpdates-tenant01-cdc_postman?desiredOutputType=JSON&tenantId=tenant01&subsId=cdc_postman&X-Atmosphere-tracking-id=0&X-Atmosphere-Framework=2.3.2-javascript&X-Atmosphere-Transport=websocket&X-atmo-protocol=true
   

5. For the headers, add key “Authorization” and “Token Key for the value”

6. To get the Token key,  run the Basic Auth in Postman.
   

7. From there, access the curl section to get the header.
   

8. Include additional headers in the socket.    

   • Cache-Control = no-cache

   • Origin =  tenant url ex. https://vcc-na3.8x8.com

   • Accept-Encoding = gzip, deflate, br, zstd

   • Pragma = no-cache

   • User-Agent =cdc_postman
     

9. Click Connect.

10. You should see a successful connection response.
    

11. Disconnect if not in use.