> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns. > > **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal): > ```bash > npx -y @scalekit-inc/cli setup -y > ``` > > Global: > ```bash > npm install -g @scalekit-inc/cli > scalekit setup -y > ``` > > Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`. > Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim. > [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/) --- # Connect AI agents to Appcues 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. **Authentication:** API Key + Secret **Categories:** Marketing **Tools:** 67: 30 read, 34 write, 3 destructive **Users sign in with:** API key **Built by:** Scalekit connector **Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=APPCUES) ## Setup 1. ### Install the SDK **Node.js** ```bash npm install @scalekit-sdk/node dotenv ``` **Python** ```bash pip install scalekit-sdk-python python-dotenv ``` 2. ### Set your credentials Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**. ```sh title=".env" SCALEKIT_ENVIRONMENT_URL= SCALEKIT_CLIENT_ID= SCALEKIT_CLIENT_SECRET= ``` 3. ### 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](/agentkit/connections/). ## Tools Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool). **Node.js** ```typescript const result = await actions.executeTool({ toolName: 'appcues_get_banner', toolInput: { banner_id: '', }, connector: 'appcues', identifier: 'user_123', }) ``` **Python** ```python result = actions.execute_tool( tool_name="appcues_get_banner", tool_input={ "banner_id": "", }, connection_name="appcues", identifier="user_123", ) ``` `result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call. ### `appcues_get_banner` Get Banner · Read-only Get details of a Banner by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `banner_id` (`string`, required): The Banner ID. Example input: `{"banner_id":""}` ### `appcues_get_checklist` Get Checklist · Read-only Get details of a Checklist by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `checklist_id` (`string`, required): The Checklist ID. Example input: `{"checklist_id":""}` ### `appcues_get_embed` Get Embed · Read-only Get details of an Embed by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `embed_id` (`string`, required): The Embed ID. Example input: `{"embed_id":""}` ### `appcues_get_filtering_rules` Get Ingestion Filtering Rules · Read-only Get the ingestion filtering rules configured for the account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_get_flow` Get Flow · Read-only Get details of a single Flow by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `flow_id` (`string`, required): The Flow ID. Example input: `{"flow_id":""}` ### `appcues_get_flow_v2` Get Flow 2.0 · Read-only Get details of a Flow 2.0 by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `flow_v2_id` (`string`, required): The Flow 2.0 ID. Example input: `{"flow_v2_id":""}` ### `appcues_get_group_profile` Get Group Profile · Read-only Get the profile of a single group by group ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `group_id` (`string`, required): The Group ID. Example input: `{"group_id":""}` ### `appcues_get_job` Get Offline Job · Read-only Get the status and details of a single offline job by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `job_id` (`string`, required): The Job ID. Example input: `{"job_id":""}` ### `appcues_get_launchpad` Get Launchpad · Read-only Get details of a Launchpad by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `launchpad_id` (`string`, required): The Launchpad ID. Example input: `{"launchpad_id":""}` ### `appcues_get_mobile_experience` Get Mobile Experience · Read-only Get details of a Mobile Experience by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `mobile_experience_id` (`string`, required): The Mobile Experience ID. Example input: `{"mobile_experience_id":""}` ### `appcues_get_nps` Get NPS 2.0 · Read-only Get details of an NPS 2.0 by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `nps_id` (`string`, required): The NPS 2.0 ID. Example input: `{"nps_id":""}` ### `appcues_get_pin` Get Pin · Read-only Get details of a Pin by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `pin_id` (`string`, required): The Pin ID. Example input: `{"pin_id":""}` ### `appcues_get_screenshots` Get Screenshots · Read-only Get a ZIP file of screenshots captured for a Flow or other experience (draft content only), by its ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `experience_id` (`string`, required): ID of the Flow or other experience to get screenshots for. Example input: `{"experience_id":""}` ### `appcues_get_segment` Get Segment · Read-only Get details of a single Segment by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `segment_id` (`string`, required): The Segment ID. Example input: `{"segment_id":""}` ### `appcues_get_tag` Get Tag · Read-only Get details of a single Tag by ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `tag_id` (`string`, required): The Tag ID. Example input: `{"tag_id":""}` ### `appcues_get_user_profile` Get User Profile · Read-only Get the profile of a single end user by user ID. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `user_id` (`string`, required): The User ID. Example input: `{"user_id":""}` ### `appcues_list_banners` List Banners · Read-only List all Banners in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_checklists` List Checklists · Read-only List all Checklists in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_embeds` List Embeds · Read-only List all Embeds in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_flows` List Flows · Read-only List all Flows in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_flows_v2` List Flows 2.0 · Read-only List all Flows 2.0 in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_jobs` List Offline Jobs · Read-only List all offline (asynchronous) jobs for the account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_launchpads` List Launchpads · Read-only List all Launchpads in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_mobile_experiences` List Mobile Experiences · Read-only List all Mobile Experiences in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_nps_surveys` List NPS 2.0 Surveys · Read-only List all NPS 2.0 Surveys in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_pins` List Pins · Read-only List all Pins in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_sdk_keys` List SDK Keys · Read-only List the SDK authentication keys for the account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_segments` List Segments · Read-only List all Segments in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_tags` List Tags · Read-only List all Tags in the Appcues account. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_list_user_events` List User Events · Read-only List tracked events for a single end user. Read only: yes. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `user_id` (`string`, required): The User ID. - `limit` (`integer`, optional): Maximum number of events to return. - `time_zone` (`string`, optional): 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). Example input: `{"user_id":""}` ### `appcues_add_users_to_group` Add Users to Group · Write Add a list of end users to a group by user ID. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `group_id` (`string`, required): The Group ID. - `user_ids` (`array`, required): List of end user IDs to add to the group. Example input: `{"group_id":"","user_ids":[]}` ### `appcues_add_users_to_segment` Add Users to Segment · Write Add a list of end users to a Segment by user ID. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `segment_id` (`string`, required): The Segment ID. - `user_ids` (`array`, required): List of end user IDs to add to the segment. Example input: `{"segment_id":"","user_ids":[]}` ### `appcues_create_sdk_key` Create SDK Key · Write Create a new SDK authentication key for the account. Read only: no. Destructive: no. Idempotent (safe to retry): no. Inputs: - `tag` (`string`, optional): A label to identify this SDK key. Example input: `{}` ### `appcues_create_segment` Create Segment · Write Create a new Segment. Read only: no. Destructive: no. Idempotent (safe to retry): no. Inputs: - `name` (`string`, required): Name of the segment. - `description` (`string`, optional): Description of the segment. Example input: `{"name":""}` ### `appcues_create_user_event` Track User Event · Write Track a new event for an end user. Read only: no. Destructive: no. Idempotent (safe to retry): no. Inputs: - `name` (`string`, required): Name of the event. - `timestamp` (`string`, required): ISO 8601 timestamp of when the event occurred. - `user_id` (`string`, required): The User ID. - `attributes` (`object`, optional): Arbitrary key/value attributes describing the event. - `context` (`object`, optional): Context object describing where the event occurred, e.g. url. - `group_id` (`string`, optional): Group ID to associate this event with. Example input: `{"name":"","timestamp":"","user_id":""}` ### `appcues_disable_enforcement_mode` Disable Enforcement Mode · Write Disable enforcement mode for the account. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_disable_secure_data_ingest` Disable Secure Data Ingest · Write Disable secure data ingest for the account. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_enable_enforcement_mode` Enable Enforcement Mode · Write Enable enforcement mode for the account. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_enable_secure_data_ingest` Enable Secure Data Ingest · Write Enable secure data ingest for the account. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: none. Example input: `{}` ### `appcues_export_events` Export Events · Write Request a bulk export of tracked events matching filter conditions, delivered by email. Read only: no. Destructive: no. Idempotent (safe to retry): no. Inputs: - `conditions` (`array`, required): 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. - `format` (`string`, required): Export file format. One of: `json`, `csv`. - `start_time` (`string`, required): Beginning of the export window — ISO 8601 format (string) or milliseconds since epoch (integer). - `email` (`string`, optional): 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_time` (`string`, optional): End of the export window — ISO 8601 format (string) or milliseconds since epoch (integer). - `limit` (`integer`, optional): Maximum number of events to export. No more than 10 million events can be exported in a single export. - `offset` (`integer`, optional): Number of rows to skip in the export results. Use with limit for paginated results. - `time_zone` (`string`, optional): 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. Example input: `{"conditions":[],"format":"json","start_time":""}` ### `appcues_export_segment_membership` Export Segment Membership · Write Request an export of a Segment's membership (user IDs and selected properties), delivered by email. Read only: no. Destructive: no. Idempotent (safe to retry): no. Inputs: - `segment_id` (`string`, required): The Segment ID. - `email` (`string`, optional): 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. - `format` (`string`, optional): Export file format. One of: `json`, `csv`. - `property_names` (`array`, optional): List of user profile property names to include in the export. The user_id is always included; if omitted, only user_id is exported. Example input: `{"segment_id":""}` ### `appcues_publish_banner` Publish Banner · Write Publish a Banner, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `banner_id` (`string`, required): The Banner ID. Example input: `{"banner_id":""}` ### `appcues_publish_checklist` Publish Checklist · Write Publish a Checklist, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `checklist_id` (`string`, required): The Checklist ID. Example input: `{"checklist_id":""}` ### `appcues_publish_embed` Publish Embed · Write Publish an Embed, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `embed_id` (`string`, required): The Embed ID. Example input: `{"embed_id":""}` ### `appcues_publish_flow` Publish Flow · Write Publish a Flow, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `flow_id` (`string`, required): The Flow ID. Example input: `{"flow_id":""}` ### `appcues_publish_flow_v2` Publish Flow 2.0 · Write Publish a Flow 2.0, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `flow_v2_id` (`string`, required): The Flow 2.0 ID. Example input: `{"flow_v2_id":""}` ### `appcues_publish_launchpad` Publish Launchpad · Write Publish a Launchpad, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `launchpad_id` (`string`, required): The Launchpad ID. Example input: `{"launchpad_id":""}` ### `appcues_publish_mobile_experience` Publish Mobile Experience · Write Publish a Mobile Experience, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `mobile_experience_id` (`string`, required): The Mobile Experience ID. Example input: `{"mobile_experience_id":""}` ### `appcues_publish_nps` Publish NPS 2.0 · Write Publish an NPS 2.0, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `nps_id` (`string`, required): The NPS 2.0 ID. Example input: `{"nps_id":""}` ### `appcues_publish_pin` Publish Pin · Write Publish a Pin, making it live to end users. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `pin_id` (`string`, required): The Pin ID. Example input: `{"pin_id":""}` ### `appcues_remove_users_from_segment` Remove Users from Segment · Write Remove a list of end users from a Segment by user ID. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `segment_id` (`string`, required): The Segment ID. - `user_ids` (`array`, required): List of end user IDs to remove from the segment. Example input: `{"segment_id":"","user_ids":[]}` ### `appcues_unpublish_banner` Unpublish Banner · Write Unpublish a Banner, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `banner_id` (`string`, required): The Banner ID. Example input: `{"banner_id":""}` ### `appcues_unpublish_checklist` Unpublish Checklist · Write Unpublish a Checklist, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `checklist_id` (`string`, required): The Checklist ID. Example input: `{"checklist_id":""}` ### `appcues_unpublish_embed` Unpublish Embed · Write Unpublish an Embed, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `embed_id` (`string`, required): The Embed ID. Example input: `{"embed_id":""}` ### `appcues_unpublish_flow` Unpublish Flow · Write Unpublish a Flow, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `flow_id` (`string`, required): The Flow ID. Example input: `{"flow_id":""}` ### `appcues_unpublish_flow_v2` Unpublish Flow 2.0 · Write Unpublish a Flow 2.0, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `flow_v2_id` (`string`, required): The Flow 2.0 ID. Example input: `{"flow_v2_id":""}` ### `appcues_unpublish_launchpad` Unpublish Launchpad · Write Unpublish a Launchpad, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `launchpad_id` (`string`, required): The Launchpad ID. Example input: `{"launchpad_id":""}` ### `appcues_unpublish_mobile_experience` Unpublish Mobile Experience · Write Unpublish a Mobile Experience, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `mobile_experience_id` (`string`, required): The Mobile Experience ID. Example input: `{"mobile_experience_id":""}` ### `appcues_unpublish_nps` Unpublish NPS 2.0 · Write Unpublish an NPS 2.0, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `nps_id` (`string`, required): The NPS 2.0 ID. Example input: `{"nps_id":""}` ### `appcues_unpublish_pin` Unpublish Pin · Write Unpublish a Pin, taking it out of production. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `pin_id` (`string`, required): The Pin ID. Example input: `{"pin_id":""}` ### `appcues_update_group_profile` Update Group Profile · Write 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. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `group_id` (`string`, required): The Group ID. - `group_name` (`string`, optional): Display name of the group. - `mission` (`string`, optional): Group's mission statement. - `plan` (`string`, optional): Group's subscription plan. Example input: `{"group_id":""}` ### `appcues_update_sdk_key` Update SDK Key · Write Update an SDK key's tag. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `sdk_key_id` (`string`, required): The SDK Key ID. - `tag` (`string`, required): New label for this SDK key. Example input: `{"sdk_key_id":"","tag":""}` ### `appcues_update_segment` Update Segment · Write Update an existing Segment's name or description. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `segment_id` (`string`, required): The Segment ID. - `description` (`string`, optional): New description of the segment. - `name` (`string`, optional): New name of the segment. Example input: `{"segment_id":""}` ### `appcues_update_user_profile` Update User Profile · Write 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. Read only: no. Destructive: no. Idempotent (safe to retry): yes. Inputs: - `user_id` (`string`, required): The User ID. - `email` (`string`, optional): User's email address. - `first_name` (`string`, optional): User's first name. - `last_name` (`string`, optional): User's last name. Example input: `{"user_id":""}` ### `appcues_delete_sdk_key` Delete SDK Key · Destructive Permanently delete an SDK authentication key. Read only: no. Destructive: yes. Idempotent (safe to retry): yes. Inputs: - `sdk_key_id` (`string`, required): The SDK Key ID. Example input: `{"sdk_key_id":""}` ### `appcues_delete_segment` Delete Segment · Destructive Permanently delete a Segment. Read only: no. Destructive: yes. Idempotent (safe to retry): yes. Inputs: - `segment_id` (`string`, required): The Segment ID. Example input: `{"segment_id":""}` ### `appcues_delete_user_profile` Delete User Profile · Destructive Permanently delete an end user's profile. Read only: no. Destructive: yes. Idempotent (safe to retry): yes. Inputs: - `user_id` (`string`, required): The User ID. Example input: `{"user_id":""}` ## Related Other Marketing connectors ([all 59](/agentkit/connectors/?category=marketing)): - [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools - [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools - [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 tools --- ## More Scalekit documentation | Resource | What it contains | When to use it | |----------|-----------------|----------------| | [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content | | [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas | | [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |