Connecting to SendPulse

To authenticate to SendPulse, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data.

Using OAuth Authentication

To obtain you OAuth credentials, log-in to your SendPulse Account and click on the Profile icon at the top right corner of the screen, then go to 'Account Settings' > 'API', and grab your Id (OAuthClientId) and Secret (OAuthClientSecret).

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuthClient.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientId: Set this to your SendPulse API Id.
OAuthClientSecret: Set this to your SendPulse API Secret.

Example connection string:

Profile=C:\profiles\SendPulse.apip;Authscheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_api_id;OAuthClientSecret=your_api_secret;

Using APIKey Authentication

You can also authenticate using a SendPulse API token you have already obtained. This bypasses the OAuth 2.0 client credentials exchange entirely; the token is sent directly in the Authorization header as a Bearer token on every request.

After obtaining your SendPulse API token, set the following connection properties:

AuthScheme: Set this to APIKey.
APIKey: Set this to your SendPulse API token.

Example APIKey connection string:

Profile=C:\profiles\SendPulse.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';

Available Tables

The SendPulse API Profile provides access to the following tables:

AutomationFlowsStatistics: Retrieve statistics for a specific automation flow (requires AutoresponderId).
BouncesDay: Retrieve information about bounces for a 24-hour period.
Campaigns: Retrieve a list of campaigns.
ConvertedContacts: Retrieve a list of subscribers who converted in an automation flow (requires AutoresponderId).
EmailStatistics: Retrieve statistics for an email address and the campaigns it is in (requires Email).
FacebookBotChats: Retrieve a list of chats with subscribers of a Facebook bot (requires BotId).
FacebookBotContactsByTag: Search for Facebook bot contacts by tag (requires BotId and Tag).
FacebookBotFlows: Retrieve a list of flows created for a Facebook bot (requires BotId).
FacebookBotMessages: Retrieve messages exchanged with a Facebook bot subscriber (requires ContactId).
FacebookBotTriggers: Retrieve triggers created for a Facebook bot (requires BotId).
FacebookBotVariables: Retrieve variables defined for a Facebook bot (requires BotId).
FacebookChatbotsAccount: Retrieve Facebook chatbots account information.
FacebookConnectedBots: Retrieve a list of connected Facebook bots.
FlowConversions: Retrieve conversion counts for an automation flow (requires AutoresponderId).
FlowStatistics: Retrieve statistics for each element in an automation flow (requires AutoresponderId).
MailingListEmails: Retrieve the emails belonging to a mailing list (requires MailingListId).
MailingLists: Retrieve a list of mailing lists (address books).
Senders: Retrieve a list of senders.
SentEmails: Retrieve a list of sent emails.
SentWebPushCampaigns: Retrieve a list of sent web push campaigns.
SentWebPushCampaignStatistics: Retrieve statistics for a sent web push campaign (requires CampaignId).
SmsBlacklist: Retrieve the SMS blacklist.
SmsCampaigns: Retrieve a list of SMS campaigns (requires Id, or DateFrom and DateTo).
TelegramAccount: Retrieve Telegram chatbots account information.
TelegramBotChats: Retrieve a list of chats with subscribers of a Telegram bot (requires BotId).
TelegramBotContactsByTag: Search for Telegram bot contacts by tag (requires BotId and Tag).
TelegramBotFlows: Retrieve a list of flows created for a Telegram bot (requires BotId).
TelegramBotMessages: Retrieve messages exchanged with a Telegram bot subscriber (requires ContactId).
TelegramBotTriggers: Retrieve triggers created for a Telegram bot (requires BotId).
TelegramBotVariables: Retrieve variables defined for a Telegram bot (requires BotId).
TelegramConnectedBots: Retrieve a list of connected Telegram bots.
Templates: Retrieve a list of email templates.
UnsubscribedUsers: Retrieve a list of unsubscribed users.
VkBotChats: Retrieve a list of chats with subscribers of a VK bot (requires BotId).
VkBotContactsByTag: Search for VK bot contacts by tag (requires BotId and Tag).
VkBotFlows: Retrieve a list of flows created for a VK bot (requires BotId).
VkBotMessages: Retrieve messages exchanged with a VK bot subscriber (requires ContactId).
VkBotTriggers: Retrieve triggers created for a VK bot (requires BotId).
VkBotVariables: Retrieve variables defined for a VK bot (requires BotId).
VkChatbotsAccount: Retrieve Vkontakte chatbots account information.
VkConnectedBots: Retrieve a list of connected VK bots.
Webhooks: Retrieve a list of webhooks.
Websites: Retrieve a list of web push websites.
WebsiteSubscribers: Retrieve subscribers for a website (requires WebsiteId).

Usage Examples

AutomationFlowsStatistics:

SELECT * FROM AutomationFlowsStatistics WHERE AutoresponderId = 'your_autoresponder_id'

BouncesDay:

SELECT * FROM BouncesDay WHERE Day = '2026-09-01'

Campaigns:

SELECT * FROM Campaigns

ConvertedContacts:

SELECT * FROM ConvertedContacts WHERE AutoresponderId = 'your_autoresponder_id'

EmailStatistics:

SELECT * FROM EmailStatistics WHERE Email = '[email protected]'

FacebookBotChats:

SELECT * FROM FacebookBotChats WHERE BotId = 'your_bot_id'

FacebookBotContactsByTag:

SELECT * FROM FacebookBotContactsByTag WHERE BotId = 'your_bot_id' AND Tag = 'your_tag'

FacebookBotFlows:

SELECT * FROM FacebookBotFlows WHERE BotId = 'your_bot_id'

FacebookBotMessages:

SELECT * FROM FacebookBotMessages WHERE ContactId = 'your_contact_id'

FacebookBotTriggers:

SELECT * FROM FacebookBotTriggers WHERE BotId = 'your_bot_id'

FacebookBotVariables:

SELECT * FROM FacebookBotVariables WHERE BotId = 'your_bot_id'

FacebookChatbotsAccount:

SELECT * FROM FacebookChatbotsAccount

FacebookConnectedBots:

SELECT * FROM FacebookConnectedBots

FlowConversions:

SELECT * FROM FlowConversions WHERE AutoresponderId = 'your_autoresponder_id'

FlowStatistics:

SELECT * FROM FlowStatistics WHERE AutoresponderId = 'your_autoresponder_id'

MailingListEmails:

SELECT * FROM MailingListEmails WHERE MailingListId = 12345

MailingLists:

SELECT * FROM MailingLists

Senders:

SELECT * FROM Senders

SentEmails:

SELECT * FROM SentEmails

SentWebPushCampaigns:

SELECT * FROM SentWebPushCampaigns

SentWebPushCampaignStatistics:

SELECT * FROM SentWebPushCampaignStatistics WHERE CampaignId = 12345

SmsBlacklist:

SELECT * FROM SmsBlacklist

SmsCampaigns:

SELECT * FROM SmsCampaigns WHERE DateFrom = '2026-01-01 00:00:00' AND DateTo = '2026-01-31 23:59:59'

TelegramAccount:

SELECT * FROM TelegramAccount

TelegramBotChats:

SELECT * FROM TelegramBotChats WHERE BotId = 'your_bot_id'

TelegramBotContactsByTag:

SELECT * FROM TelegramBotContactsByTag WHERE BotId = 'your_bot_id' AND Tag = 'your_tag'

TelegramBotFlows:

SELECT * FROM TelegramBotFlows WHERE BotId = 'your_bot_id'

TelegramBotMessages:

SELECT * FROM TelegramBotMessages WHERE ContactId = 'your_contact_id'

TelegramBotTriggers:

SELECT * FROM TelegramBotTriggers WHERE BotId = 'your_bot_id'

TelegramBotVariables:

SELECT * FROM TelegramBotVariables WHERE BotId = 'your_bot_id'

TelegramConnectedBots:

SELECT * FROM TelegramConnectedBots

Templates:

SELECT * FROM Templates

UnsubscribedUsers:

SELECT * FROM UnsubscribedUsers WHERE Day = '2026-09-01'

VkBotChats:

SELECT * FROM VkBotChats WHERE BotId = 'your_bot_id'

VkBotContactsByTag:

SELECT * FROM VkBotContactsByTag WHERE BotId = 'your_bot_id' AND Tag = 'your_tag'

VkBotFlows:

SELECT * FROM VkBotFlows WHERE BotId = 'your_bot_id'

VkBotMessages:

SELECT * FROM VkBotMessages WHERE ContactId = 'your_contact_id'

VkBotTriggers:

SELECT * FROM VkBotTriggers WHERE BotId = 'your_bot_id'

VkBotVariables:

SELECT * FROM VkBotVariables WHERE BotId = 'your_bot_id'

VkChatbotsAccount:

SELECT * FROM VkChatbotsAccount

VkConnectedBots:

SELECT * FROM VkConnectedBots

Webhooks:

SELECT * FROM Webhooks

Websites:

SELECT * FROM Websites

WebsiteSubscribers:

SELECT * FROM WebsiteSubscribers WHERE WebsiteId = 12345

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The SendPulse API token used to authenticate when AuthScheme is set to APIKey.
AuthScheme	The scheme used for authentication. Accepted entries are None, OAuthClient, or APIKey. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD
CallbackURL	Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, REFRESH, GETANDREFRESH
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.
OAuthVerifier	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.