All Tutorials

Define a new Kit Skill

All Tutorials

Define a new Kit Skill

Define a new Kit Skill

This section covers how to define a Kit Skill from your Partner Dashboard. When you define a Kit Skill you provide the Kit Skill details, as well as the components of a standard or extended conversation.

Writing for your Kit Skill

Guidelines for writing conversations for your Kit Skill can be found within our Polaris documentation. These guidelines will help you create conversational experiences that feel natural and fluid, and are consistent in tone and structure.

You’re encouraged to draft your Kit Skill conversations before beginning development. Understanding the conversational flow of your Kit Skill can help you scope the development work more effectively.

Standard and extended conversations

You can build standard and extended conversations using Kit's conversational components:

Standard and extended conversations use the following flows:

Both standard and extended conversations include the Proposal, Prompt, and Confirmation components. These components support placeholder Liquid variables that enable you to include shop data variables in your Kit conversations. The values for these variables are filled when triggering a Kit conversation.

To learn how to write a conversation using Kit's voice and tone, see the Polaris documentation.

Create a Kit Skill

  1. From your Partner Dashboard, click Apps.
  2. Click the name of the app that you want to change.
  3. Click Extensions.
  4. Click Kit.
  5. Under Extend your app with Kit Skills, click Manage Kit Skills.
  6. Provide a name for the Kit Skill and a description that describes the action that it takes.
  7. In the Endpoint URL and Feedback Endpoint URL fields, enter your app's execution and feedback endpoints.
  8. Select the Kit Skill's type that you're creating. The Kit Skill's type determines the settings for Marketing platform and Ad format. This is described in more detail in the components reference.
  9. Construct the content of the conversation using the guidelines for standard and extended conversations. Follow the writing guidance in Conversational experiences to make sure that the voice and tone are correct.
  10. After you're done, click Submit for approval.

Standard conversations

Standard conversations are built with a proposal, prompt, and confirmation. They don't include an opt-in or any questions.

Steps:

  1. Provide a Proposal message, and a Prompt. The Prompt is appended to the Proposal during the merchant conversation.
  2. Provide acceptance and rejection confirmation messages. The messages are displayed when the merchant accepts or rejects the prompt.

Extended conversations

Extended conversations are built with a Proposal, an Opt-in, as well as one or more Follow-up questions, a Prompt, and the Confirmation messages.

Steps:

  1. Provide a Proposal message, and a Prompt. The Prompt is appended after the Follow-up questions.
  2. Provide an Opt-in message. The Opt-in is appended to the proposal message.
  3. Under Follow-up questions, add a Follow-up question and select a response type. There are two response types:

Components reference

Kit Skill type

When you create a conversation, you can define the Kit Skill type and its corresponding marketing platform and ad format:

  • Type: Type of action to be taken in response to the merchant conversation. Choose Other if you are not building a marketing app.
  • Marketing platform: Marketing platform where the action is executed. Kit Skill type dictates specific marketing platforms.
  • Ad format: Format in which the ad is delivered. Not all Kit Skills require an Ad format.

The following table describes the supported fields for the various Kit Skill types.

Type Available marketing platforms Available ad formats
Ad Facebook, Instagram, Google, Bing, Other Carousel ad, Link ad, Other
Retargeting Facebook, Instagram, Google, Bing, Other Retargeting
Post Facebook, Instagram, Google, Bing, Other Not applicable
Message Facebook, Other Not applicable

Components

Component Description
Proposal The portion of the first message in a new Kit conversation that proposes a task. For standard conversations, the prompt is added to the end of this message. For extended conversations, the opt-in is added to the end of this message. You can use Liquid parameters. Maximum of 350 characters.
Opt-in Extended conversations include follow-up questions and require an opt-in message. The opt-in message is used to confirm the merchant’s intent to take action (which then triggers the follow-up questions). For extended conversations, the opt-in message is appended to the end of the proposal message instead of the prompt message. Maximum of 200 characters.
Prompt Confirm the merchant’s intent to take action with a prompt. If no follow-up questions are needed, the prompt message is appended to the end of the proposal message. Otherwise, it is sent after the merchant responds to the last follow-up question. You can use Liquid parameters to reference the merchant's previous responses, if available. Maximum of 200 characters.
Confirmation Acceptance If the merchant responds to the prompt message with “yes,” Kit confirms that the task was completed. You can use liquid parameters to reference the merchant's previous responses if available. Maximum of 200 characters.
Rejection If the merchant says “no” to the prompt message, Kit confirms that no action was performed. Maximum of 200 characters.

Review our guidelines on conversational experiences for more details on these components.

Follow-up questions

Follow-up questions are used to obtain information from the merchant required to execute your app's task.

Expected responses

Expected responses enable you to define a list of possible values for the merchant to choose from in the response. For example, you can use an expected response type to obtain the desired budget for a marketing activity from a list of options.

Component Description
Variable name The API identifier. Use snake_case (lowercase letters, numbers, and underscores only).
Question A question that will accept a response from a list. Ask one question at a time and be precise about the expected response. Begin with an acknowledgement phrase or word. Maximum 200 characters.
Expected response options Display value The value displayed for the merchant to select.
Actual value The value that is returned to you.

Free form text

Free-form text questions enable the merchant to respond with free-form text. For example, you can use a Free-form text response to obtain the copy to be used in an ad campaign.

Component Description
Variable name The API identifier. Use snake_case (lowercase letters, numbers, and underscores only).
Question A question that will accept a free-form response. Ask one question at a time and be precise about the expected response. Begin with an acknowledgement phrase or word. Maximum 200 characters.