Connect AI agents to Appcues

Scalekit connector

The Appcues connector lets your AI agent act in each user's Appcues account. Each user connects their own Appcues API key and secret once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 67 tools.

Tools: 67
What they doRead · write · destructive: 30 · 34 · 330 read34 write3 destructive
Users sign in with: API key

Setup

Install the SDK
- Node.js
- Python
Terminal window
npm install @scalekit-sdk/node dotenv
Terminal window
pip install scalekit-sdk-python python-dotenv
Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the Appcues connection
In AgentKit > Connections, create an Appcues connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

appcues_get_bannerGet details of a Banner by ID.Read-only
Get Banner
Get details of a Banner by ID.
Inputs
banner_idstringrequired
The Banner ID.
appcues_get_checklistGet details of a Checklist by ID.Read-only
Get Checklist
Get details of a Checklist by ID.
Inputs
checklist_idstringrequired
The Checklist ID.
appcues_get_embedGet details of an Embed by ID.Read-only
Get Embed
Get details of an Embed by ID.
Inputs
embed_idstringrequired
The Embed ID.
appcues_get_filtering_rulesGet the ingestion filtering rules configured for the account.Read-only
Get Ingestion Filtering Rules
Get the ingestion filtering rules configured for the account.
Inputs
This tool takes no inputs.
appcues_get_flowGet details of a single Flow by ID.Read-only
Get Flow
Get details of a single Flow by ID.
Inputs
flow_idstringrequired
The Flow ID.
appcues_get_flow_v2Get details of a Flow 2.0 by ID.Read-only
Get Flow 2.0
Get details of a Flow 2.0 by ID.
Inputs
flow_v2_idstringrequired
The Flow 2.0 ID.
appcues_get_group_profileGet the profile of a single group by group ID.Read-only
Get Group Profile
Get the profile of a single group by group ID.
Inputs
group_idstringrequired
The Group ID.
appcues_get_jobGet the status and details of a single offline job by ID.Read-only
Get Offline Job
Get the status and details of a single offline job by ID.
Inputs
job_idstringrequired
The Job ID.
appcues_get_launchpadGet details of a Launchpad by ID.Read-only
Get Launchpad
Get details of a Launchpad by ID.
Inputs
launchpad_idstringrequired
The Launchpad ID.
appcues_get_mobile_experienceGet details of a Mobile Experience by ID.Read-only
Get Mobile Experience
Get details of a Mobile Experience by ID.
Inputs
mobile_experience_idstringrequired
The Mobile Experience ID.
appcues_get_npsGet details of an NPS 2.0 by ID.Read-only
Get NPS 2.0
Get details of an NPS 2.0 by ID.
Inputs
nps_idstringrequired
The NPS 2.0 ID.
appcues_get_pinGet details of a Pin by ID.Read-only
Get Pin
Get details of a Pin by ID.
Inputs
pin_idstringrequired
The Pin ID.
appcues_get_screenshotsGet a ZIP file of screenshots captured for a Flow or other experience (draft content only), by its ID.Read-only
Get Screenshots
Get a ZIP file of screenshots captured for a Flow or other experience (draft content only), by its ID.
Inputs
experience_idstringrequired
ID of the Flow or other experience to get screenshots for.
appcues_get_segmentGet details of a single Segment by ID.Read-only
Get Segment
Get details of a single Segment by ID.
Inputs
segment_idstringrequired
The Segment ID.
appcues_get_tagGet details of a single Tag by ID.Read-only
Get Tag
Get details of a single Tag by ID.
Inputs
tag_idstringrequired
The Tag ID.
appcues_get_user_profileGet the profile of a single end user by user ID.Read-only
Get User Profile
Get the profile of a single end user by user ID.
Inputs
user_idstringrequired
The User ID.
appcues_list_bannersList all Banners in the Appcues account.Read-only
List Banners
List all Banners in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_checklistsList all Checklists in the Appcues account.Read-only
List Checklists
List all Checklists in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_embedsList all Embeds in the Appcues account.Read-only
List Embeds
List all Embeds in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_flowsList all Flows in the Appcues account.Read-only
List Flows
List all Flows in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_flows_v2List all Flows 2.0 in the Appcues account.Read-only
List Flows 2.0
List all Flows 2.0 in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_jobsList all offline (asynchronous) jobs for the account.Read-only
List Offline Jobs
List all offline (asynchronous) jobs for the account.
Inputs
This tool takes no inputs.
appcues_list_launchpadsList all Launchpads in the Appcues account.Read-only
List Launchpads
List all Launchpads in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_mobile_experiencesList all Mobile Experiences in the Appcues account.Read-only
List Mobile Experiences
List all Mobile Experiences in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_nps_surveysList all NPS 2.0 Surveys in the Appcues account.Read-only
List NPS 2.0 Surveys
List all NPS 2.0 Surveys in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_pinsList all Pins in the Appcues account.Read-only
List Pins
List all Pins in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_sdk_keysList the SDK authentication keys for the account.Read-only
List SDK Keys
List the SDK authentication keys for the account.
Inputs
This tool takes no inputs.
appcues_list_segmentsList all Segments in the Appcues account.Read-only
List Segments
List all Segments in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_tagsList all Tags in the Appcues account.Read-only
List Tags
List all Tags in the Appcues account.
Inputs
This tool takes no inputs.
appcues_list_user_eventsList tracked events for a single end user.Read-only
List User Events
List tracked events for a single end user.
Inputs
user_idstringrequired
The User ID.
limitinteger
Maximum number of events to return.
time_zonestring
Time zone to render event timestamps in — either a UTC offset string (e.g. -04:00) or an integer number of minutes offset from UTC (e.g. -240).
appcues_add_users_to_groupAdd a list of end users to a group by user ID.Write
Add Users to Group
Add a list of end users to a group by user ID.
- Idempotent
Inputs
group_idstringrequired
The Group ID.
user_idsarrayrequired
List of end user IDs to add to the group.
appcues_add_users_to_segmentAdd a list of end users to a Segment by user ID.Write
Add Users to Segment
Add a list of end users to a Segment by user ID.
- Idempotent
Inputs
segment_idstringrequired
The Segment ID.
user_idsarrayrequired
List of end user IDs to add to the segment.
appcues_create_sdk_keyCreate a new SDK authentication key for the account.Write
Create SDK Key
Create a new SDK authentication key for the account.
Inputs
tagstring
A label to identify this SDK key.
appcues_create_segmentCreate a new Segment.Write
Create Segment
Create a new Segment.
Inputs
namestringrequired
Name of the segment.
descriptionstring
Description of the segment.
appcues_create_user_eventTrack a new event for an end user.Write
Track User Event
Track a new event for an end user.
Inputs
namestringrequired
Name of the event.
timestampstringrequired
ISO 8601 timestamp of when the event occurred.
user_idstringrequired
The User ID.
attributesobject
Arbitrary key/value attributes describing the event.
contextobject
Context object describing where the event occurred, e.g. url.
group_idstring
Group ID to associate this event with.
appcues_disable_enforcement_modeDisable enforcement mode for the account.Write
Disable Enforcement Mode
Disable enforcement mode for the account.
- Idempotent
Inputs
This tool takes no inputs.
appcues_disable_secure_data_ingestDisable secure data ingest for the account.Write
Disable Secure Data Ingest
Disable secure data ingest for the account.
- Idempotent
Inputs
This tool takes no inputs.
appcues_enable_enforcement_modeEnable enforcement mode for the account.Write
Enable Enforcement Mode
Enable enforcement mode for the account.
- Idempotent
Inputs
This tool takes no inputs.
appcues_enable_secure_data_ingestEnable secure data ingest for the account.Write
Enable Secure Data Ingest
Enable secure data ingest for the account.
- Idempotent
Inputs
This tool takes no inputs.
appcues_export_eventsRequest a bulk export of tracked events matching filter conditions, delivered by email.Write
Export Events
Request a bulk export of tracked events matching filter conditions, delivered by email.
Inputs
conditionsarrayrequired
List of [field, operator, value] filter conditions, e.g. [['flow_id', '==', 'df6b6ce8-9666-4e54-bbff-b0607af5b597']]. Conditions may be combined with 'and'/'or' as the first element.
formatstringrequired
Export file format.one of jsoncsv
start_timestringrequired
Beginning of the export window — ISO 8601 format (string) or milliseconds since epoch (integer).
emailstring
Email address(es) results should be sent to — a single address or an array of addresses. Optional — the export can also be retrieved via appcues_get_job using the job_id returned by this call.
end_timestring
End of the export window — ISO 8601 format (string) or milliseconds since epoch (integer).
limitinteger
Maximum number of events to export. No more than 10 million events can be exported in a single export.
offsetinteger
Number of rows to skip in the export results. Use with limit for paginated results.
time_zonestring
Time zone applied to start_time/end_time — a UTC offset string (e.g. -04:00) or an integer number of minutes offset from UTC.
appcues_export_segment_membershipRequest an export of a Segment's membership (user IDs and selected properties), delivered by email.Write
Export Segment Membership
Request an export of a Segment's membership (user IDs and selected properties), delivered by email.
Inputs
segment_idstringrequired
The Segment ID.
emailstring
Email address the export will be sent to. Optional — the export can also be retrieved via appcues_get_job using the job_id returned by this call.
formatstring
Export file format.one of jsoncsv
property_namesarray
List of user profile property names to include in the export. The user_id is always included; if omitted, only user_id is exported.
appcues_publish_bannerPublish a Banner, making it live to end users.Write
Publish Banner
Publish a Banner, making it live to end users.
- Idempotent
Inputs
banner_idstringrequired
The Banner ID.
appcues_publish_checklistPublish a Checklist, making it live to end users.Write
Publish Checklist
Publish a Checklist, making it live to end users.
- Idempotent
Inputs
checklist_idstringrequired
The Checklist ID.
appcues_publish_embedPublish an Embed, making it live to end users.Write
Publish Embed
Publish an Embed, making it live to end users.
- Idempotent
Inputs
embed_idstringrequired
The Embed ID.
appcues_publish_flowPublish a Flow, making it live to end users.Write
Publish Flow
Publish a Flow, making it live to end users.
- Idempotent
Inputs
flow_idstringrequired
The Flow ID.
appcues_publish_flow_v2Publish a Flow 2.0, making it live to end users.Write
Publish Flow 2.0
Publish a Flow 2.0, making it live to end users.
- Idempotent
Inputs
flow_v2_idstringrequired
The Flow 2.0 ID.
appcues_publish_launchpadPublish a Launchpad, making it live to end users.Write
Publish Launchpad
Publish a Launchpad, making it live to end users.
- Idempotent
Inputs
launchpad_idstringrequired
The Launchpad ID.
appcues_publish_mobile_experiencePublish a Mobile Experience, making it live to end users.Write
Publish Mobile Experience
Publish a Mobile Experience, making it live to end users.
- Idempotent
Inputs
mobile_experience_idstringrequired
The Mobile Experience ID.
appcues_publish_npsPublish an NPS 2.0, making it live to end users.Write
Publish NPS 2.0
Publish an NPS 2.0, making it live to end users.
- Idempotent
Inputs
nps_idstringrequired
The NPS 2.0 ID.
appcues_publish_pinPublish a Pin, making it live to end users.Write
Publish Pin
Publish a Pin, making it live to end users.
- Idempotent
Inputs
pin_idstringrequired
The Pin ID.
appcues_remove_users_from_segmentRemove a list of end users from a Segment by user ID.Write
Remove Users from Segment
Remove a list of end users from a Segment by user ID.
- Idempotent
Inputs
segment_idstringrequired
The Segment ID.
user_idsarrayrequired
List of end user IDs to remove from the segment.
appcues_unpublish_bannerUnpublish a Banner, taking it out of production.Write
Unpublish Banner
Unpublish a Banner, taking it out of production.
- Idempotent
Inputs
banner_idstringrequired
The Banner ID.
appcues_unpublish_checklistUnpublish a Checklist, taking it out of production.Write
Unpublish Checklist
Unpublish a Checklist, taking it out of production.
- Idempotent
Inputs
checklist_idstringrequired
The Checklist ID.
appcues_unpublish_embedUnpublish an Embed, taking it out of production.Write
Unpublish Embed
Unpublish an Embed, taking it out of production.
- Idempotent
Inputs
embed_idstringrequired
The Embed ID.
appcues_unpublish_flowUnpublish a Flow, taking it out of production.Write
Unpublish Flow
Unpublish a Flow, taking it out of production.
- Idempotent
Inputs
flow_idstringrequired
The Flow ID.
appcues_unpublish_flow_v2Unpublish a Flow 2.0, taking it out of production.Write
Unpublish Flow 2.0
Unpublish a Flow 2.0, taking it out of production.
- Idempotent
Inputs
flow_v2_idstringrequired
The Flow 2.0 ID.
appcues_unpublish_launchpadUnpublish a Launchpad, taking it out of production.Write
Unpublish Launchpad
Unpublish a Launchpad, taking it out of production.
- Idempotent
Inputs
launchpad_idstringrequired
The Launchpad ID.
appcues_unpublish_mobile_experienceUnpublish a Mobile Experience, taking it out of production.Write
Unpublish Mobile Experience
Unpublish a Mobile Experience, taking it out of production.
- Idempotent
Inputs
mobile_experience_idstringrequired
The Mobile Experience ID.
appcues_unpublish_npsUnpublish an NPS 2.0, taking it out of production.Write
Unpublish NPS 2.0
Unpublish an NPS 2.0, taking it out of production.
- Idempotent
Inputs
nps_idstringrequired
The NPS 2.0 ID.
appcues_unpublish_pinUnpublish a Pin, taking it out of production.Write
Unpublish Pin
Unpublish a Pin, taking it out of production.
- Idempotent
Inputs
pin_idstringrequired
The Pin ID.
appcues_update_group_profileUpdate group_name, mission, and/or plan on a group's profile.Write
Update Group Profile
Update group_name, mission, and/or plan on a group's profile. NOTE: the real Appcues API accepts arbitrary custom profile properties too (the entire request body is used as key-value group profile data) — this tool only exposes the three named fields above; other custom properties can't be set through this tool.
- Idempotent
Inputs
group_idstringrequired
The Group ID.
group_namestring
Display name of the group.
missionstring
Group's mission statement.
planstring
Group's subscription plan.
appcues_update_sdk_keyUpdate an SDK key's tag.Write
Update SDK Key
Update an SDK key's tag.
- Idempotent
Inputs
sdk_key_idstringrequired
The SDK Key ID.
tagstringrequired
New label for this SDK key.
appcues_update_segmentUpdate an existing Segment's name or description.Write
Update Segment
Update an existing Segment's name or description.
- Idempotent
Inputs
segment_idstringrequired
The Segment ID.
descriptionstring
New description of the segment.
namestring
New name of the segment.
appcues_update_user_profileUpdate first_name, last_name, and/or email on an end user's profile.Write
Update User Profile
Update first_name, last_name, and/or email on an end user's profile. NOTE: the real Appcues API accepts arbitrary custom profile properties too (the entire request body is used as key-value user profile data) — this tool only exposes the three named fields above; other custom properties can't be set through this tool.
- Idempotent
Inputs
user_idstringrequired
The User ID.
emailstring
User's email address.
first_namestring
User's first name.
last_namestring
User's last name.
appcues_delete_sdk_keyPermanently delete an SDK authentication key.Destructive
Delete SDK Key
Permanently delete an SDK authentication key.
- Idempotent
Inputs
sdk_key_idstringrequired
The SDK Key ID.
appcues_delete_segmentPermanently delete a Segment.Destructive
Delete Segment
Permanently delete a Segment.
- Idempotent
Inputs
segment_idstringrequired
The Segment ID.
appcues_delete_user_profilePermanently delete an end user's profile.Destructive
Delete User Profile
Permanently delete an end user's profile.
- Idempotent
Inputs
user_idstringrequired
The User ID.

Setup

Install the SDK

Set your credentials

Create the Appcues connection

Tools

Call it

Returns

Get Banner

Inputs

Get Checklist

Inputs

Get Embed

Inputs

Get Ingestion Filtering Rules

Inputs

Get Flow

Inputs

Get Flow 2.0

Inputs

Get Group Profile

Inputs

Get Offline Job

Inputs

Get Launchpad

Inputs

Get Mobile Experience

Inputs

Get NPS 2.0

Inputs

Get Pin

Inputs

Get Screenshots

Inputs

Get Segment

Inputs

Get Tag

Inputs

Get User Profile

Inputs

List Banners

Inputs

List Checklists

Inputs

List Embeds

Inputs

List Flows

Inputs

List Flows 2.0

Inputs

List Offline Jobs

Inputs

List Launchpads

Inputs

List Mobile Experiences

Inputs

List NPS 2.0 Surveys

Inputs

List Pins

Inputs

List SDK Keys

Inputs

List Segments

Inputs

List Tags

Inputs

List User Events

Inputs

Add Users to Group

Inputs

Add Users to Segment

Inputs

Create SDK Key

Inputs

Create Segment

Inputs

Track User Event

Inputs

Disable Enforcement Mode

Inputs

Disable Secure Data Ingest