> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Kit

> How to set up the Kit connector, plus the actions and events that are available.

![Kit](https://stackone-logos.com/api/convertkit/filled/svg)

v1.2.1[See changelog](https://docs.stackone.com/connectors/kit/changelog.md)

[57 actions](#actions) · [24 events](#events) · 1 auth method

Marketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/kit/guides/connector-profile/oauth-2-0.md)
>
> Create an OAuth2 application in Kit to get Client ID and Secret. Required for write operations. Kit API rate limit is 60...

Optionally, configure receiving Events for Kit into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/kit/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/kit/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

57 actions

ActionDescription

Get Current Account`kit_get_account`

Retrieve the current Kit account and user information

Get Creator Profile`kit_get_creator_profile`

Retrieve the creator profile for the current account

Get Email Stats`kit_get_email_stats`

Retrieve email performance counts for the current account

Get Growth Stats`kit_get_growth_stats`

Retrieve subscriber growth statistics for a specific time period

List Account Colors`kit_list_account_colors`

Retrieve the color settings for the current account

Update Account Colors`kit_update_account_colors`

Update the color settings for the current account

Create Broadcast`kit_create_broadcast`

Draft or schedule a broadcast email to all or a subset of subscribers

List Broadcasts`kit_list_broadcasts`

Retrieve a paginated list of all broadcasts

Get Broadcast`kit_get_broadcast`

Retrieve a specific broadcast by ID

Update Broadcast`kit_update_broadcast`

Update an existing broadcast

Delete Broadcast`kit_delete_broadcast`

Delete a broadcast by ID

Get Broadcast Stats`kit_get_broadcast_stats`

Retrieve performance statistics for a specific broadcast

List Broadcasts Stats`kit_list_broadcasts_stats`

Retrieve statistics for multiple broadcasts

Get Broadcast Link Clicks`kit_get_broadcast_link_clicks`

Retrieve link click data for a specific broadcast

Create Custom Field`kit_create_custom_field`

Create a new custom field for subscribers

Bulk Create Custom Fields`kit_bulk_create_custom_fields`

Create multiple custom fields in a single request

List Custom Fields`kit_list_custom_fields`

Retrieve all custom fields

Update Custom Field`kit_update_custom_field`

Update a custom field label by ID

Delete Custom Field`kit_delete_custom_field`

Delete a custom field by ID

List Email Templates`kit_list_email_templates`

Retrieve all available email templates

List Forms`kit_list_forms`

Retrieve a paginated list of all forms

List Form Subscribers`kit_list_form_subscribers`

Retrieve subscribers who signed up through a specific form

Add Subscriber To Form`kit_add_subscriber_to_form`

Add an existing subscriber to a form by subscriber ID

Add Subscriber To Form By Email`kit_add_subscriber_to_form_by_email`

Add an existing subscriber to a form by email address

Bulk Add Subscribers To Forms`kit_bulk_add_subscribers_to_forms`

Add multiple subscribers to forms in a single request

Create Purchase`kit_create_purchase`

Record a new purchase for a subscriber

List Purchases`kit_list_purchases`

Retrieve a paginated list of all purchases

Get Purchase`kit_get_purchase`

Retrieve a specific purchase by ID

List Segments`kit_list_segments`

Retrieve a paginated list of all segments

Create Sequence`kit_create_sequence`

Create a new email sequence

List Sequences`kit_list_sequences`

Retrieve a paginated list of all sequences

Add Subscriber To Sequence`kit_add_subscriber_to_sequence`

Add an existing subscriber to a sequence

Add Subscriber To Sequence By Email`kit_add_subscriber_to_sequence_by_email`

Add a subscriber to a sequence by email address

List Sequence Subscribers`kit_list_sequence_subscribers`

Retrieve subscribers enrolled in a specific sequence

Create Subscriber`kit_create_subscriber`

Create or update a subscriber (upsert)

Bulk Create Subscribers`kit_bulk_create_subscribers`

Create multiple subscribers in a single request

Get Subscriber`kit_get_subscriber`

Retrieve a specific subscriber by ID

List Subscribers`kit_list_subscribers`

Retrieve a paginated list of all subscribers

Update Subscriber`kit_update_subscriber`

Update an existing subscriber by ID

Unsubscribe Subscriber`kit_unsubscribe_subscriber`

Unsubscribe a subscriber by ID

Get Subscriber Stats`kit_get_subscriber_stats`

Retrieve email statistics for a specific subscriber

List Subscriber Tags`kit_list_subscriber_tags`

Retrieve all tags assigned to a specific subscriber

Filter Subscribers By Engagement`kit_filter_subscribers_by_engagement`

Filter subscribers based on email engagement metrics

Create Tag`kit_create_tag`

Create a new tag

Bulk Create Tags`kit_bulk_create_tags`

Create multiple tags in a single request

List Tags`kit_list_tags`

Retrieve a paginated list of all tags

Update Tag`kit_update_tag`

Update a tag name by ID

Tag Subscriber`kit_tag_subscriber`

Add a tag to a subscriber by subscriber ID

Tag Subscriber By Email`kit_tag_subscriber_by_email`

Add a tag to a subscriber by email address

Bulk Tag Subscribers`kit_bulk_tag_subscribers`

Apply tags to multiple subscribers in a single request

List Tag Subscribers`kit_list_tag_subscribers`

Retrieve subscribers assigned to a specific tag

Remove Tag From Subscriber`kit_remove_tag_from_subscriber`

Remove a tag from a subscriber by subscriber ID

Remove Tag From Subscriber By Email`kit_remove_tag_from_subscriber_by_email`

Remove a tag from a subscriber by email address

Bulk Remove Tags From Subscribers`kit_bulk_remove_tags_from_subscribers`

Remove tags from multiple subscribers in a single request

Create Webhook`kit_create_webhook`

Create a webhook subscription for a specific event

List Webhooks`kit_list_webhooks`

Retrieve all webhook subscriptions

Delete Webhook`kit_delete_webhook`

Delete a webhook subscription by ID

## Events

Tags

Select all
|
Clear

Broadcasts

Custom Fields

Posts

Sequences

Subscribers

Tags

Webhooks

No tags found

24 events

EventDescriptionTags

Active Check`kit_active_check`

Acknowledges Kit deliveries that carry no events or an event type this connector does not map.

Webhooks

Subscriber Created`kit_webhook_subscriber_created`

Fires on the Kit subscriber.created event.

SubscribersWebhooks

Subscriber Activated`kit_webhook_subscriber_activated`

Fires on the Kit subscriber.activated event.

SubscribersWebhooks

Subscriber Unsubscribed`kit_webhook_subscriber_unsubscribed`

Fires on the Kit subscriber.unsubscribed event.

SubscribersWebhooks

Subscriber Bounced`kit_webhook_subscriber_bounced`

Fires on the Kit subscriber.bounced event.

SubscribersWebhooks

Subscriber Complained`kit_webhook_subscriber_complained`

Fires on the Kit subscriber.complained event.

SubscribersWebhooks

Subscriber Subscribed to Form`kit_webhook_subscriber_subscribed_to_form`

Fires on the Kit subscriber.subscribed\_to\_form event.

SubscribersWebhooks

Subscriber Added to Sequence`kit_webhook_subscriber_added_to_sequence`

Fires on the Kit subscriber.added\_to\_sequence event.

SubscribersWebhooks

Subscriber Sequence Completed`kit_webhook_subscriber_sequence_completed`

Fires on the Kit subscriber.sequence\_completed event.

SubscribersWebhooks

Subscriber Tag Added`kit_webhook_subscriber_tag_added`

Fires on the Kit subscriber.tag\_added event.

SubscribersWebhooks

Subscriber Tag Removed`kit_webhook_subscriber_tag_removed`

Fires on the Kit subscriber.tag\_removed event.

SubscribersWebhooks

Subscriber Custom Field Value Updated`kit_webhook_subscriber_custom_field_value_updated`

Fires on the Kit subscriber.custom\_field\_value\_updated event.

SubscribersWebhooks

Tag Created`kit_webhook_tag_created`

Fires on the Kit tag.created event.

TagsWebhooks

Tag Deleted`kit_webhook_tag_deleted`

Fires on the Kit tag.deleted event.

TagsWebhooks

Custom Field Created`kit_webhook_custom_field_created`

Fires on the Kit custom\_field.created event.

Custom FieldsWebhooks

Custom Field Deleted`kit_webhook_custom_field_deleted`

Fires on the Kit custom\_field.deleted event.

Custom FieldsWebhooks

Sequence Created`kit_webhook_sequence_created`

Fires on the Kit sequence.created event.

SequencesWebhooks

Sequence Deleted`kit_webhook_sequence_deleted`

Fires on the Kit sequence.deleted event.

SequencesWebhooks

Sequence Published`kit_webhook_sequence_published`

Fires on the Kit sequence.published event.

SequencesWebhooks

Sequence Disabled`kit_webhook_sequence_disabled`

Fires on the Kit sequence.disabled event.

SequencesWebhooks

Broadcast Created`kit_webhook_broadcast_created`

Fires on the Kit broadcast.created event.

BroadcastsWebhooks

Broadcast Sent`kit_webhook_broadcast_sent`

Fires on the Kit broadcast.sent event.

BroadcastsWebhooks

Broadcast Deleted`kit_webhook_broadcast_deleted`

Fires on the Kit broadcast.deleted event.

BroadcastsWebhooks

Post Published`kit_webhook_post_published`

Fires on the Kit post.published event.

PostsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.