Appcues

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. 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>

What you can do

Connect this agent connector to let your agent:

• Update user profile, segment, sdk key — Update first_name, last_name, and/or email on an end user’s profile
• Pin unpublish, publish — Unpublish a Pin, taking it out of production
• Nps unpublish, publish — Unpublish an NPS 2.0, taking it out of production
• Experience unpublish mobile, publish mobile — Unpublish a Mobile Experience, taking it out of production
• Launchpad unpublish, publish — Unpublish a Launchpad, taking it out of production
• V2 unpublish flow, publish flow — Unpublish a Flow 2.0, taking it out of production

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

appcues_add_users_to_group#Add a list of end users to a group by user ID.2 params▾

Add a list of end users to a group by user ID.

NameTypeRequiredDescription

group_idstringrequiredThe Group ID.

user_idsarrayrequiredList of end user IDs to add to the group.

appcues_add_users_to_segment#Add a list of end users to a Segment by user ID.2 params▾

Add a list of end users to a Segment by user ID.

NameTypeRequiredDescription

segment_idstringrequiredThe Segment ID.

user_idsarrayrequiredList of end user IDs to add to the segment.

appcues_create_sdk_key#Create a new SDK authentication key for the account.1 param▾

Create a new SDK authentication key for the account.

NameTypeRequiredDescription

tagstringoptionalA label to identify this SDK key.

appcues_create_segment#Create a new Segment.2 params▾

Create a new Segment.

NameTypeRequiredDescription

namestringrequiredName of the segment.

descriptionstringoptionalDescription of the segment.

appcues_create_user_event#Track a new event for an end user.6 params▾

Track a new event for an end user.

NameTypeRequiredDescription

namestringrequiredName of the event.

timestampstringrequiredISO 8601 timestamp of when the event occurred.

user_idstringrequiredThe User ID.

attributesobjectoptionalArbitrary key/value attributes describing the event.

contextobjectoptionalContext object describing where the event occurred, e.g. url.

group_idstringoptionalGroup ID to associate this event with.

appcues_delete_sdk_key#Permanently delete an SDK authentication key.1 param▾

Permanently delete an SDK authentication key.

NameTypeRequiredDescription

sdk_key_idstringrequiredThe SDK Key ID.

appcues_delete_segment#Permanently delete a Segment.1 param▾

Permanently delete a Segment.

NameTypeRequiredDescription

segment_idstringrequiredThe Segment ID.

appcues_delete_user_profile#Permanently delete an end user's profile.1 param▾

Permanently delete an end user's profile.

NameTypeRequiredDescription

user_idstringrequiredThe User ID.

appcues_disable_enforcement_mode#Disable enforcement mode for the account.0 params▾

Disable enforcement mode for the account.

appcues_disable_secure_data_ingest#Disable secure data ingest for the account.0 params▾

Disable secure data ingest for the account.

appcues_enable_enforcement_mode#Enable enforcement mode for the account.0 params▾

Enable enforcement mode for the account.

appcues_enable_secure_data_ingest#Enable secure data ingest for the account.0 params▾

Enable secure data ingest for the account.

appcues_export_events#Request a bulk export of tracked events matching filter conditions, delivered by email.8 params▾

Request a bulk export of tracked events matching filter conditions, delivered by email.

NameTypeRequiredDescription

conditionsarrayrequiredList 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.

formatstringrequiredExport file format.

start_timestringrequiredBeginning of the export window — ISO 8601 format (string) or milliseconds since epoch (integer).

emailstringoptionalEmail 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_timestringoptionalEnd of the export window — ISO 8601 format (string) or milliseconds since epoch (integer).

limitintegeroptionalMaximum number of events to export. No more than 10 million events can be exported in a single export.

offsetintegeroptionalNumber of rows to skip in the export results. Use with limit for paginated results.

time_zonestringoptionalTime 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_membership#Request an export of a Segment's membership (user IDs and selected properties), delivered by email.4 params▾

Request an export of a Segment's membership (user IDs and selected properties), delivered by email.

NameTypeRequiredDescription

segment_idstringrequiredThe Segment ID.

emailstringoptionalEmail 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.

formatstringoptionalExport file format.

property_namesarrayoptionalList of user profile property names to include in the export. The user_id is always included; if omitted, only user_id is exported.

appcues_get_banner#Get details of a Banner by ID.1 param▾

Get details of a Banner by ID.

NameTypeRequiredDescription

banner_idstringrequiredThe Banner ID.

appcues_get_checklist#Get details of a Checklist by ID.1 param▾

Get details of a Checklist by ID.

NameTypeRequiredDescription

checklist_idstringrequiredThe Checklist ID.

appcues_get_embed#Get details of an Embed by ID.1 param▾

Get details of an Embed by ID.

NameTypeRequiredDescription

embed_idstringrequiredThe Embed ID.

appcues_get_filtering_rules#Get the ingestion filtering rules configured for the account.0 params▾

Get the ingestion filtering rules configured for the account.

appcues_get_flow#Get details of a single Flow by ID.1 param▾

Get details of a single Flow by ID.

NameTypeRequiredDescription

flow_idstringrequiredThe Flow ID.

appcues_get_flow_v2#Get details of a Flow 2.0 by ID.1 param▾

Get details of a Flow 2.0 by ID.

NameTypeRequiredDescription

flow_v2_idstringrequiredThe Flow 2.0 ID.

appcues_get_group_profile#Get the profile of a single group by group ID.1 param▾

Get the profile of a single group by group ID.

NameTypeRequiredDescription

group_idstringrequiredThe Group ID.

appcues_get_job#Get the status and details of a single offline job by ID.1 param▾

Get the status and details of a single offline job by ID.

NameTypeRequiredDescription

job_idstringrequiredThe Job ID.

appcues_get_launchpad#Get details of a Launchpad by ID.1 param▾

Get details of a Launchpad by ID.

NameTypeRequiredDescription

launchpad_idstringrequiredThe Launchpad ID.

appcues_get_mobile_experience#Get details of a Mobile Experience by ID.1 param▾

Get details of a Mobile Experience by ID.

NameTypeRequiredDescription

mobile_experience_idstringrequiredThe Mobile Experience ID.

appcues_get_nps#Get details of an NPS 2.0 by ID.1 param▾

Get details of an NPS 2.0 by ID.

NameTypeRequiredDescription

nps_idstringrequiredThe NPS 2.0 ID.

appcues_get_pin#Get details of a Pin by ID.1 param▾

Get details of a Pin by ID.

NameTypeRequiredDescription

pin_idstringrequiredThe Pin ID.

appcues_get_screenshots#Get a ZIP file of screenshots captured for a Flow or other experience (draft content only), by its ID.1 param▾

Get a ZIP file of screenshots captured for a Flow or other experience (draft content only), by its ID.

NameTypeRequiredDescription

experience_idstringrequiredID of the Flow or other experience to get screenshots for.

appcues_get_segment#Get details of a single Segment by ID.1 param▾

Get details of a single Segment by ID.

NameTypeRequiredDescription

segment_idstringrequiredThe Segment ID.

appcues_get_tag#Get details of a single Tag by ID.1 param▾

Get details of a single Tag by ID.

NameTypeRequiredDescription

tag_idstringrequiredThe Tag ID.

appcues_get_user_profile#Get the profile of a single end user by user ID.1 param▾

Get the profile of a single end user by user ID.

NameTypeRequiredDescription

user_idstringrequiredThe User ID.

appcues_list_banners#List all Banners in the Appcues account.0 params▾

List all Banners in the Appcues account.

appcues_list_checklists#List all Checklists in the Appcues account.0 params▾

List all Checklists in the Appcues account.

appcues_list_embeds#List all Embeds in the Appcues account.0 params▾

List all Embeds in the Appcues account.

appcues_list_flows#List all Flows in the Appcues account.0 params▾

List all Flows in the Appcues account.

appcues_list_flows_v2#List all Flows 2.0 in the Appcues account.0 params▾

List all Flows 2.0 in the Appcues account.

appcues_list_jobs#List all offline (asynchronous) jobs for the account.0 params▾

List all offline (asynchronous) jobs for the account.

appcues_list_launchpads#List all Launchpads in the Appcues account.0 params▾

List all Launchpads in the Appcues account.

appcues_list_mobile_experiences#List all Mobile Experiences in the Appcues account.0 params▾

List all Mobile Experiences in the Appcues account.

appcues_list_nps_surveys#List all NPS 2.0 Surveys in the Appcues account.0 params▾

List all NPS 2.0 Surveys in the Appcues account.

appcues_list_pins#List all Pins in the Appcues account.0 params▾

List all Pins in the Appcues account.

appcues_list_sdk_keys#List the SDK authentication keys for the account.0 params▾

List the SDK authentication keys for the account.

appcues_list_segments#List all Segments in the Appcues account.0 params▾

List all Segments in the Appcues account.

appcues_list_tags#List all Tags in the Appcues account.0 params▾

List all Tags in the Appcues account.

appcues_list_user_events#List tracked events for a single end user.3 params▾

List tracked events for a single end user.

NameTypeRequiredDescription

user_idstringrequiredThe User ID.

limitintegeroptionalMaximum number of events to return.

time_zonestringoptionalTime 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_publish_banner#Publish a Banner, making it live to end users.1 param▾

Publish a Banner, making it live to end users.

NameTypeRequiredDescription

banner_idstringrequiredThe Banner ID.

appcues_publish_checklist#Publish a Checklist, making it live to end users.1 param▾

Publish a Checklist, making it live to end users.

NameTypeRequiredDescription

checklist_idstringrequiredThe Checklist ID.

appcues_publish_embed#Publish an Embed, making it live to end users.1 param▾

Publish an Embed, making it live to end users.

NameTypeRequiredDescription

embed_idstringrequiredThe Embed ID.

appcues_publish_flow#Publish a Flow, making it live to end users.1 param▾

Publish a Flow, making it live to end users.

NameTypeRequiredDescription

flow_idstringrequiredThe Flow ID.

appcues_publish_flow_v2#Publish a Flow 2.0, making it live to end users.1 param▾

Publish a Flow 2.0, making it live to end users.

NameTypeRequiredDescription

flow_v2_idstringrequiredThe Flow 2.0 ID.

appcues_publish_launchpad#Publish a Launchpad, making it live to end users.1 param▾

Publish a Launchpad, making it live to end users.

NameTypeRequiredDescription

launchpad_idstringrequiredThe Launchpad ID.

appcues_publish_mobile_experience#Publish a Mobile Experience, making it live to end users.1 param▾

Publish a Mobile Experience, making it live to end users.

NameTypeRequiredDescription

mobile_experience_idstringrequiredThe Mobile Experience ID.

appcues_publish_nps#Publish an NPS 2.0, making it live to end users.1 param▾

Publish an NPS 2.0, making it live to end users.

NameTypeRequiredDescription

nps_idstringrequiredThe NPS 2.0 ID.

appcues_publish_pin#Publish a Pin, making it live to end users.1 param▾

Publish a Pin, making it live to end users.

NameTypeRequiredDescription

pin_idstringrequiredThe Pin ID.

appcues_remove_users_from_segment#Remove a list of end users from a Segment by user ID.2 params▾

Remove a list of end users from a Segment by user ID.

NameTypeRequiredDescription

segment_idstringrequiredThe Segment ID.

user_idsarrayrequiredList of end user IDs to remove from the segment.

appcues_unpublish_banner#Unpublish a Banner, taking it out of production.1 param▾

Unpublish a Banner, taking it out of production.

NameTypeRequiredDescription

banner_idstringrequiredThe Banner ID.

appcues_unpublish_checklist#Unpublish a Checklist, taking it out of production.1 param▾

Unpublish a Checklist, taking it out of production.

NameTypeRequiredDescription

checklist_idstringrequiredThe Checklist ID.

appcues_unpublish_embed#Unpublish an Embed, taking it out of production.1 param▾

Unpublish an Embed, taking it out of production.

NameTypeRequiredDescription

embed_idstringrequiredThe Embed ID.

appcues_unpublish_flow#Unpublish a Flow, taking it out of production.1 param▾

Unpublish a Flow, taking it out of production.

NameTypeRequiredDescription

flow_idstringrequiredThe Flow ID.

appcues_unpublish_flow_v2#Unpublish a Flow 2.0, taking it out of production.1 param▾

Unpublish a Flow 2.0, taking it out of production.

NameTypeRequiredDescription

flow_v2_idstringrequiredThe Flow 2.0 ID.

appcues_unpublish_launchpad#Unpublish a Launchpad, taking it out of production.1 param▾

Unpublish a Launchpad, taking it out of production.

NameTypeRequiredDescription

launchpad_idstringrequiredThe Launchpad ID.

appcues_unpublish_mobile_experience#Unpublish a Mobile Experience, taking it out of production.1 param▾

Unpublish a Mobile Experience, taking it out of production.

NameTypeRequiredDescription

mobile_experience_idstringrequiredThe Mobile Experience ID.

appcues_unpublish_nps#Unpublish an NPS 2.0, taking it out of production.1 param▾

Unpublish an NPS 2.0, taking it out of production.

NameTypeRequiredDescription

nps_idstringrequiredThe NPS 2.0 ID.

appcues_unpublish_pin#Unpublish a Pin, taking it out of production.1 param▾

Unpublish a Pin, taking it out of production.

NameTypeRequiredDescription

pin_idstringrequiredThe Pin ID.

appcues_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.4 params▾

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.

NameTypeRequiredDescription

group_idstringrequiredThe Group ID.

group_namestringoptionalDisplay name of the group.

missionstringoptionalGroup's mission statement.

planstringoptionalGroup's subscription plan.

appcues_update_sdk_key#Update an SDK key's tag.2 params▾

Update an SDK key's tag.

NameTypeRequiredDescription

sdk_key_idstringrequiredThe SDK Key ID.

tagstringrequiredNew label for this SDK key.

appcues_update_segment#Update an existing Segment's name or description.3 params▾

Update an existing Segment's name or description.

NameTypeRequiredDescription

segment_idstringrequiredThe Segment ID.

descriptionstringoptionalNew description of the segment.

namestringoptionalNew name of the segment.

appcues_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.4 params▾

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.

NameTypeRequiredDescription

user_idstringrequiredThe User ID.

emailstringoptionalUser's email address.

first_namestringoptionalUser's first name.

last_namestringoptionalUser's last name.