The Communication Center API
Disclaimer
Beta-stage product. This solution is in the beta stage and therefore considered a Beta-stage product. It is clarified that if there are any faults and/or issues, it will not affect your obligation to provide us with the requested and accurate information and documentation. This information should be delivered with no dependency on the stability and performance of the product. If the product is not working as expected, you should use any other alternative to fulfill your obligations as described above.
Introduction
The Communication Center API gives you access to the case-based conversations that Rapyd's internal case management system generates for your account. Rather than relying on email threads or manual support tickets, you can retrieve, create, and manage these conversations directly from your own systems: pulling a list of open cases, reading the full message history for a specific case, replying with new messages, and attaching supporting files such as invoices, screenshots, or signed documents. Each case is represented as a communication thread, and each thread is made up of an ordered series of messages, so the API's structure mirrors the way these conversations already happen between you and Rapyd.
Beyond simple retrieval, the API supports two-way communication: you can post new messages into an existing thread, upload files as attachments, and download attached files by reference. To keep your systems in sync without polling, Rapyd also sends webhook notifications whenever a new thread is opened or a new message is added to one you're already part of, so you can react to updates as they happen. This guide walks through the available endpoints, and the webhook payloads you'll receive.
Nota
Production server address is the same as in the merchant API requests. See also Environments.
Intended Audience
The document is intended for developers who have a basic understanding of the following:
REST APIs that request and receive data in the JSON (JavaScript Object Notation) format.
Running REST API methods on Postman or integrating these methods in any programming language.
Nota
The merchant must also be subscribed to receive related webhooks to their defined server address.
Requests and Webhooks
Communication Threads
The following requests are included for communication threads:
Files
The following requests are included for uploading and downloading files:
Webhooks
The following webhooks are included: