# Attentive Integration

## Log into your Existing Attentive Account

<figure><img src="/files/KcEzAkebIs8tM2uwmBtN" alt=""><figcaption><p>Log into your Attentive account and head to the main dashboard.</p></figcaption></figure>

## Head to your Marketplace page in Attentive to create a new app

<figure><img src="/files/WWYUXnVyGbbAUElXWlRV" alt=""><figcaption><p>Head to marketplace to create a custom attentive app</p></figcaption></figure>

## Create a Custom App named Subrise Subscriptions

<figure><img src="/files/dq1z7IxXm6CTXAtnUGHO" alt=""><figcaption><p>Name your app Subrise Subscriptions, and set the permissions as such.</p></figcaption></figure>

## Grab the API Key From The Subrise App

<figure><img src="/files/1z60DMC9OyF01nKf494C" alt=""><figcaption></figcaption></figure>

## Head to the Subrise App, and go to Settings Tab

<figure><img src="/files/B7r5yEnPfnwI2PRqNLAn" alt=""><figcaption><p>Click the "Attentive" integrations card, and paste in the API Key from the custom Attentive App.</p></figcaption></figure>

## Set Up a New Attentive Journey

<figure><img src="/files/K8Bn5vKISTeKNN4QieSq" alt=""><figcaption><p>Create a new Journey</p></figcaption></figure>

<figure><img src="/files/a5aGv9h5xeFABkGtWpD1" alt=""><figcaption><p>Start from Scatch</p></figcaption></figure>

## Choose from one of our Many Subrise Event Triggers

<figure><img src="/files/7SaqbsgMiCP1kVndYK1p" alt=""><figcaption></figcaption></figure>

## You are now connected to Attentive through Subrise!

***

## Datatypes and Events

The Subrise Subscription application, will send subscription-based data to your Attentive account for a variety of different Events. Below are the following Events you can expect to receive data for, as well as the format of that data.

### Events

* [New Subscription](#new-subscription-payload)
* [New Subscriber](#new-subscriber-payload)
* [Subscription Cancelled](#subscription-cancelled-payload)
* [Subscription Modified](#subscription-modified)
* [Upcoming Invoice](#upcoming-invoice-payload)
* [Failed Transaction](#failed-transaction-payload)
* [Successful Payment](#successful-payment-payload)
* [Pause Subscription](#pause-subscription-payload)
* [Reactivated Subscription](#reactivated-subscription-payload)
* [Prepaid Subscription](#prepaid-subscription-payload)
* [Addon Subscription](#addon-subscription-payload)

### New Subscription Payload

```
{
    metric: "subrise_new_subscription",
    customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    subscription_line_items: [
     {
      variant_title: blue shirt,
      price: 1.99,
      quantity: 1,
      discounted_price: 1.99,
    },
    ],
    total_subscription_price: 1.99,
    subscription_started_date: "2024-05-14T17:52:47.910Z",
  }

```

### New Subscriber Payload

```
  {
    metric: "subrise_new_subscriber",
    customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    subscription_total: 1.99,
    subscription_started: "2024-05-14T17:52:47.910Z",
    subscription_line_items: [
     {
      variant_title: blue shirt,
      price: 1.99,
      quantity: 1,
      discounted_price: 1.99,
    },
    ]
  }

```

### Subscription Cancelled Payload

```

{
    metric: "subrise_subscription_cancelled",
    customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    reason: "too good",
    reason_details: "The deal was too good",
    total_subscription_orders: 1,
    subscription_cancelled_date: "2024-05-14T17:52:47.910Z",
  }

```

### Subscription Modified

*updatedField, and updatedValue will correspond to the different fields that may or may not get updated on a Subscription object.*

```

{
    metric: "subrise_subscription_modified",
    customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    subscription_modified_date: "2024-05-14T17:52:47.910Z",
    updatedField1:"deliveryInterval",
    updatedValue1:"MONTH",
    updatedField2:"deliveryIntervalCount",
    updatedValue2:1,
    updatedField3:"billingInterval".
    updatedValue3:"MONTH",
    updatedField4:"billingIntervalCount",
    updatedValue4:1,
    updatedField5:"maxCycles",
    updatedValue5:NULL,
    updatedField6:"minCycles",
    updatedValue6:NULL,
    updatedField7:"isPrepaid",
    updatedValue7:false,
  }

```

### Upcoming Invoice Payload

```

{
    metric: "subrise_upcoming_invoice",
    customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    subscription_invoice_date: "2024-05-14T17:52:47.910Z",
  }

```

### Failed Transaction Payload

```

{
    metric: "subrise_failed_transaction",
     customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    total_subscription_price: 1.99
    failed_billing_error_message: "error",
    card_info: 1234,
  }
`
```

### Successful Payment Payload

```

 {
    metric: "subrise_successful_payment",
    customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    total_subscription_price: 1.99
    payment_date: "2024-05-14T17:52:47.910Z",
  }

```

### Pause Subscription Payload

```
{
    metric: "subrise_pause_subscription",
   customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    pause_reason: "price",
    pauseDetails: "Could not afford this anymore",
    total_subscription_orders: 3,
    subscription_paused_date: "2024-05-14T17:52:47.910Z"
  }
```

### Reactivated Subscription Payload

````

{
    metric: "subrise_reactivate_sub",
    customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    total_subscription_price: 1.99
    subscription_updated_date: "2024-05-14T17:52:47.910Z"
  }
```
````

### Prepaid Subscription Payload

````

{
    metric: "subrise_prepaid_subscription",
     customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    total_subscription_price: 1.99,
    subscription_started: "2024-05-14T17:52:47.910Z",
    subscription_line_items: [
     {
      variant_title: blue shirt,
      price: 1.99,
      quantity: 1,
      discounted_price: 1.99,
    },
    ]
  }
```
````

### Addon Subscription Payload

```
{
    metric: "subrise_addon_purchase",
    customer_first_name: "John",
    customer_last_name: "Doe",
    customer_email: "johndoe@test.com",
    customer_phone: "444-444-4444",
    customer_id: "12345678910"
    subscription_id: "12345678910",
    subscription_total: 1.99,
    subscription_started: "2024-05-14T17:52:47.910Z",
    addon_line_items: [
     {
      variant_title: blue shirt,
      price: 1.99,
      quantity: 1,
      discounted_price: 1.99,
    },
    ]
  }
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.subrise.app/guide/settings/integrations/attentive-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
