Skip to main content

Developers

Build on ThriveVas.

Connect your applications to communication and digital services through developer-friendly APIs and integrations.

Capabilities

Everything the platform exposes.

ThriveVas capabilities are reachable programmatically, so messaging, interactive services and payments can live inside your own product.

  • REST API

    Send messages and interact with ThriveVas capabilities over HTTP from your own systems.

  • Webhooks

    Receive delivery events and status updates as your integrations progress.

  • Delivery reports

    Track the status of messages so your application reflects what actually happened.

  • Integrations

    Connect messaging and interactive services into CRM, ERP and commerce platforms.

  • Documentation

    Full request and response references live in the developer documentation.

  • Developer support

    A development support team is available to help you through integration.

Authentication

Authenticate, then make your first request.

API access is authenticated with a token issued to your account. The request identifies your API key, the shortcode the message is sent from, and the origin of the call.

Request fields

  • apiKey — your issued API token
  • shortCode — the identity messages are sent from
  • origin — the interface the request originates from

Field names, value formats and the full parameter set are documented in the developer documentation.

Authentication request
javascript
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://app.thrivevas.com",
  "method": "POST",
  "headers": {
    "cache-control": "no-cache"
  },
  "data": {
    "apiKey": "api token here",
    "shortCode": "ThriveVas",
    "origin": "API_INTERFACE"
  }
}

Request format as published in the existing ThriveVas API section.

Endpoints

Send, receive and follow up.

The developer API is reached over HTTP at the ThriveVas platform host. The base host and authentication method are published below; the authoritative endpoint list lives in the documentation.

Base host
Base host
https://app.thrivevas.com
Method
POST
Interface origin
API_INTERFACE
Full reference

Webhooks & delivery

Follow the lifecycle of every request.

Delivery reports show the status of messages so your application can reflect what actually happened. Webhooks let your systems receive status events as they occur rather than polling for them.

Following a request

  • Submit the request with your API key
  • Receive an acknowledgement for the submission
  • Read delivery status from reports
  • Subscribe to webhooks for status events
Acknowledgement
json
{
  "status": "accepted",
  "message": "Request received",
  "documentation": "https://docs.thrivevas.com"
}

Illustrative acknowledgement shape. See the documentation for the authoritative response schema.

Integration workflow

From zero to an integrated capability.

A typical integration follows the same four steps whether you are adding messaging, an interactive service or a payment flow.

  1. Get credentialsObtain your API key and confirm the shortcode you will send from.
  2. Make a requestPOST to the platform host with your key, shortcode and origin.
  3. Handle responsesProcess acknowledgements and delivery status for each request.
  4. Go to productionWire it into your workflows with webhooks and support on call.

Support

You are not integrating alone.

The ThriveVas Developer API documentation offers all the instructions you need to connect and use our services. Our development support team is ready to help you whenever you need help.

  • API
  • Webhooks
  • Delivery Reports
  • Integrations
  • Documentation
Resources
  • API referenceRequests, responses and fields
  • WebhooksStatus events and subscriptions
  • IntegrationsConnecting existing systems
  • Developer supportHelp while you build

Ready to build on ThriveVas?

Get an account, obtain your API key, or talk to our team about a more complex integration.