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

# Attentive

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

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

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

[19 actions](#actions) · [12 events](#events) · 2 auth methods

Marketing
Messaging
E-Commerce

## 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] [API Key · Connector Profile](https://docs.stackone.com/connectors/attentive/guides/connector-profile/api-key.md)
>
> Uses an API key from a custom app, with access limited to the permissions set on the app. Supports Identify User, which...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/attentive/guides/connector-profile/oauth-2-0.md)
>
> Requires a custom app enabled for distribution in Attentive. The access token does not expire and is limited to the scop...

Optionally, configure receiving Events for Attentive into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/attentive/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] [API Key · Link Account](https://docs.stackone.com/connectors/attentive/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/attentive/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

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

attributes:write

ecommerce:write

events:write

privacy\_requests:read

privacy\_requests:write

product\_catalogs:read

product\_catalogs:write

subscriptions:read

subscriptions:write

No scopes found

19 actions

ActionDescriptionRequired scopes

Get Me`attentive_get_me`

Test authentication and retrieve company information

Subscribe User`attentive_subscribe_user`

Subscribe a user to receive communications

`subscriptions:write`

Get Subscription`attentive_get_subscription`

Get subscription eligibility for a user. Requires at least one of phone or email

`subscriptions:read`

Unsubscribe Subscriptions For A User`attentive_unsubscribe_user`

Unsubscribe a user from subscription type or channel

`subscriptions:write`

Product View`attentive_product_view`

Track when a user views a product

`ecommerce:write`

Add To Cart`attentive_add_to_cart`

Track when a user adds a product to their shopping cart

`ecommerce:write`

Purchase`attentive_purchase`

Track when a user generates an order or purchase

`ecommerce:write`

Send Custom Event`attentive_send_custom_event`

Track custom business events

`events:write`

Set Custom Attributes`attentive_set_custom_attributes`

Store custom user attributes

`attributes:write`

Get Custom Attributes`attentive_get_custom_attributes`

Retrieve custom attributes for a user. Requires exactly one of phone or email

`attributes:write`

Upload Product Catalog`attentive_upload_product_catalog`

Get a pre-signed S3 URL to upload your product catalog

`product_catalogs:write`

View Recent Catalog Uploads`attentive_list_catalog_uploads`

List recent catalog uploads with their statuses

`product_catalogs:read`

Lookup Product Catalog Ingestion`attentive_lookup_product_catalog_ingestion`

Get updated information on how the upload is progressing

`product_catalogs:read`

Add A Deletion Request`attentive_add_deletion_request`

Add a CCPA data deletion request

`privacy_requests:write`

Get A CCPA Delete Request By Id`attentive_get_deletion_request`

Get a CCPA delete request by Id

`privacy_requests:read`

Identify User`attentive_identify_user`

Add a client user identifier or custom identifier(s) to a user

Create Or Update User With Attributes`attentive_create_or_update_user_v2`

Create or update a single user with attributes, subscriptions, and identifiers

`attributes:write``subscriptions:write`

Bulk Update User Attributes`attentive_bulk_update_user_attributes`

Process bulk user attribute updates

`attributes:write``subscriptions:write`

Get Bulk Job Status`attentive_get_bulk_job_status`

Retrieve status of a bulk ingestion job

## Events

Tags

Select all
|
Clear

Custom Attributes

Messages

Subscriptions

Verification

Webhooks

No tags found

12 events

EventDescriptionTags

Active Check`attentive_active_check`

Acknowledges Attentive deliveries with no recognised event type with a 200 response, so Attentive does not retry them.

VerificationWebhooks

SMS Subscribed`attentive_webhook_sms_subscribed`

Processes Attentive sms.subscribed events, fired when a user opts in to SMS marketing or transactional messages (subscri...

SubscriptionsWebhooks

SMS Unsubscribed`attentive_webhook_sms_unsubscribed`

Processes Attentive sms.unsubscribed events, fired when a user opts out of SMS (subscriber and subscription type).

SubscriptionsWebhooks

SMS Sent`attentive_webhook_sms_sent`

Processes Attentive sms.sent events, fired when Attentive sends an SMS to a subscriber (subscriber and message id, type,...

MessagesWebhooks

SMS Link Clicked`attentive_webhook_sms_message_link_click`

Processes Attentive sms.message\_link\_click events, fired when a subscriber clicks a link in an SMS (subscriber and link...

MessagesWebhooks

SMS Inbound Message`attentive_webhook_sms_inbound_message`

Processes Attentive sms.inbound\_message events, fired when a subscriber replies to an SMS (subscriber and the reply type...

MessagesWebhooks

Email Subscribed`attentive_webhook_email_subscribed`

Processes Attentive email.subscribed events, fired when a user opts in to email (subscriber, sign-up creative and subscr...

SubscriptionsWebhooks

Email Unsubscribed`attentive_webhook_email_unsubscribed`

Processes Attentive email.unsubscribed events, fired when a user opts out of email (subscriber and subscription type).

SubscriptionsWebhooks

Email Sent`attentive_webhook_email_sent`

Processes Attentive email.sent events, fired when Attentive sends an email to a subscriber (subscriber and message id, s...

MessagesWebhooks

Email Opened`attentive_webhook_email_opened`

Processes Attentive email.opened events, fired when a subscriber opens an email (subscriber and message id, type, name a...

MessagesWebhooks

Email Link Clicked`attentive_webhook_email_message_link_click`

Processes Attentive email.message\_link\_click events, fired when a subscriber clicks a link in an email (subscriber and l...

MessagesWebhooks

Custom Attribute Set`attentive_webhook_custom_attribute_set`

Processes Attentive custom\_attribute.set events, fired when a custom attribute is added or updated for a subscriber (sub...

Custom AttributesWebhooks


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