CONNECT APP
Build with VBOUT
VBOUT offers several marketing tools into one powerful platform: Social media, landing pages, lead management, email marketing, automation and analytics.
Marketing
- API key
MCP
Give your agent VBOUT tools
Every VBOUT action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's VBOUT account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "vbout",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add Contact To List:
const result = await mcp.callTool({
name: "vbout-add-contact-to-list",
arguments: {
listFrom: "List",
contact: "Contact",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "vbout",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add Contact To List:
result = await session.call_tool("vbout-add-contact-to-list", {
"listFrom": "List",
"contact": "Contact",
})API PROXY
Call the VBOUT API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the VBOUT API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.vbout.com/1/app/me.json",
})
// Any allowed VBOUT endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.vbout.com/1/app/me.json
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkudmJvdXQuY29tLzEvYXBwL21lLmpzb24?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run VBOUT actions from your backend
Connect a user's VBOUT account once, then run Add Contact To List on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "vbout-add-contact-to-list",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
vbout: { authProvisionId: "apn_xxxxxxx" },
listFrom: "List",
contact: "Contact",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="vbout-add-contact-to-list",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"vbout": {"authProvisionId": "apn_xxxxxxx"},
"listFrom": "List",
"contact": "Contact",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "vbout-add-contact-to-list",
"configured_props": {
"vbout": { "authProvisionId": "apn_xxxxxxx" },
"listFrom": "List",
"contact": "Contact"
}
}'TOOLS
VBOUT actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Contact To List
actionThis action move a contact to a specific list. See the docs hereWritev0.0.2 -
Add Contact To List By Email
actionThis action add a specific list to a contact. All emails having the same email text available in the provided list will be updated if exists See the docs hereWritev0.0.2 -
Add Custom Event To Contact
actionThis action add a custom activity to the contact. See the docs hereWritev0.0.2 -
Create Email List
actionThis action creates a new list. See the docs hereWritev0.0.2 -
Create Email Marketing Campaign
actionThis action creates a new email marketing campaign. See the docs hereWritev0.0.2 -
Create Social Media Message
actionThis action creates a new post on social media. See the documentationWritev0.0.3 -
List Audiences Options
actionRetrieves available options for the Audiences field.Read-onlyv0.0.1 -
List Channel Options
actionRetrieves available options for the Channel field.Read-onlyv0.0.1 -
List List Options
actionRetrieves available options for the List field.Read-onlyv0.0.1 -
Unsubscribe Contact
actionThis action unsubscribes a specific contact from a list. See the docs hereWritev0.0.2 -
Update Contact
actionThis action updates a specific contact. See the docs hereWritev0.0.2
-
New Contact
triggerEmit new event for each new contact. See docs herev0.0.4 -
New Contact Property Change
triggerEmit new event for each new property changed in a specific contact. See docs herev0.0.4 -
New Email Campaign
triggerEmit new event for each new email campaign. See docs herev0.0.4 -
New Social Media Message
triggerEmit new event for each new social media message. See docs herev0.0.4
- App slug
- vbout
- Authentication
- API key
- Categories
- Marketing
- Actions
- 11
- Triggers
- 4
- API proxy
- Available