Salesforce SDK Overview

This guide is designed for Salesforce teams deploying the Conversive SDK into their own org, Force.com applications and for ISVs embedding it into a Salesforce-based product.

The Conversive Salesforce SDK gives you an Apex-first way to configure your messaging environment, connect a Conversive account, send SMS and MMS messages, and read balance and plan information directly from Salesforce.

Deploy the SDK

Install the SDK from source, deploy metadata, configure permissions, update the endpoint, and complete post-deployment validation.

Use the APIs

Configure environment settings, create an account, send bulk SMS and MMS, and retrieve balance and plan details.

Review the FAQ

Find answers to common implementation questions about sender records, supported objects, credits, and messaging behavior.

What you can do with the SDK

With the ConversiveAPI Apex class, your Salesforce team can:

  • Configure environment settings for API access
  • Create a Conversive account from Salesforce
  • Send plain text SMS messages
  • Send bulk SMS messages to multiple records in one call
  • Send MMS messages with text or media only
  • Check available SMS and MMS credits
  • Fetch current plan details for the connected account

Brevo-style developer docs work well because they lead with a short quickstart, then split deployment, authentication/setup, task-based APIs, and FAQ into separate pages. This guide follows the same pattern so a developer can move from installation to first successful API calls quickly.

1

Deploy metadata

Deploy the SDK source and required metadata into your target Salesforce org.

2

Complete org setup

Assign the required permission set, update the remote site setting, configure integration details, and verify sender records.

3

Connect the org

Use upsertEnvironmentSettings() and createConversiveAccount() during onboarding.

4

Send messages

Use sendBulkSMS() and sendBulkMMS() for operational, workflow, or campaign-style messaging.

5

Monitor account state

Use getConversiveBalance() and getConversivePlanDetails() to monitor credits and plan information.

Core SDK touchpoints

ItemPurpose
ConversiveAPIMain Apex entry point for setup, account, balance, plan, SMS, and MMS operations
Conversive_Integration_Details__cStores API key and endpoint path used by the SDK
Sender_Id__cStores sender identities used for outbound messaging
Conversive AccessPermission set required for users who will work with the SDK
Conversive_Staging_APIRemote Site Setting used to allow outbound callouts to the Conversive endpoint

Before you begin

Make sure the following are available before you start working with the SDK:

  • Salesforce CLI
  • An authenticated target org
  • A local clone of the SDK repository
  • Permissions to deploy metadata and run Apex
  • Recipient records in Salesforce
  • At least one valid sender record in Sender_Id__c
Use the correct endpoint for your environment

Your source guides include both QA-style and production-style base URLs. Use the endpoint that matches your environment before publishing snippets or running setup in a live org.

Next steps