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

# Rise.ai

> Automatically issue gift cards for approved claims using Rise.ai.

<Note>
  Order Protection integrates with Rise.ai to automatically issue gift cards to customers when their claims are approved, providing a seamless resolution experience.
</Note>

## Overview

The Rise.ai integration allows you to automatically create and manage gift cards for customers. Order Protection uses Rise.ai for:

* **Claim Resolution**: Automatically issue gift cards when claims are approved
* **Bonus Store Credit**: Issue store credit as customer rewards or incentives
* **Balance Updates**: Add additional amounts to existing customer loyalty cards

When a claim is approved and resolved via gift card, or when bonus credit is issued, Order Protection automatically creates or updates a Rise.ai gift card and sends it to the customer.

## Prerequisites

Before setting up the Rise.ai integration, ensure you have:

* An active Rise.ai account
* Your store configured in Order Protection
* One or both of the following, depending on which integration path you use:
  * Your Rise.ai **Credit API Token** (for the Credit API path)
  * A **Trigger ID** from a configured Rise trigger workflow (for the Trigger workflow path)

## Installation

Rise.ai supports two paths for issuing store credit through Order Protection:

* **Credit API** — Order Protection calls Rise's Credit API directly to issue gift cards.
* **Trigger workflow** — Order Protection dispatches to a Rise trigger workflow you've built. Use this path if your store has migrated off the Credit API.

<Tip>
  If both a Credit API Token and a Trigger ID are configured, Order Protection uses the trigger workflow first and falls back to the Credit API.
</Tip>

### Credit API setup

<Steps>
  <Step title="Get Your Credit API Token">
    Log in to your Rise.ai account and navigate to your settings to retrieve your Credit API Token. If you don't see this option, reach out to your Rise.ai customer support contact.

    <Tip>
      The Credit API Token is different from other API keys - make sure you're using the Credit API Token specifically.
    </Tip>
  </Step>

  <Step title="Navigate to Integrations">
    In your Order Protection dashboard, go to **Settings > Integrations** and find Rise.ai in the list of available integrations.
  </Step>

  <Step title="Enter Your API Token">
    Click on the Rise.ai integration card and enter your Credit API Token in the field provided.

    The Credit API Token allows Order Protection to:

    * Create gift cards on your behalf
    * Attribute claim resolution gift cards to customer accounts
    * Track gift card balances and usage
  </Step>

  <Step title="Save Configuration" icon="check">
    Click **Save** to complete the integration setup.

    Your Rise.ai integration is now active and ready to automatically issue gift cards for approved claims.
  </Step>
</Steps>

### Trigger workflow setup

Use this path if your Rise account has switched to trigger-based workflows. You'll build the workflow in Rise, then paste the Trigger ID into Order Protection.

#### Create a Trigger workflow in Rise

<Steps>
  <Step title="Open Workflows in Rise">
    Log in to your Rise.ai account and navigate to **Workflows**.
  </Step>

  <Step title="Create a new workflow">
    Click **Create workflow** in the top right.
  </Step>

  <Step title="Choose &#x22;Create your own&#x22;">
    Scroll to the bottom of the template list and click **Create your own**.
  </Step>

  <Step title="Create a custom trigger">
    In the left nav, scroll down and click **Create your own** again to build a custom trigger.
  </Step>

  <Step title="Name the trigger">
    Enter `Order Protection Store Credit` as the trigger name.
  </Step>

  <Step title="Configure variables">
    Update the variables so the trigger can receive customer data from Order Protection:

    * Change the existing **customer email** variable's path to `email`.
    * Click **Add variable** and configure:
      * **Name:** `amount`
      * **Type:** Number
      * **Path:** `amount` (lowercase)

    Then click **Create trigger** at the bottom.
  </Step>

  <Step title="Copy the Trigger ID">
    After you click **Create trigger**, Rise displays a pop-up containing the workflow's execute URL (e.g. `https://workflows.rise-ai.com/execute/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`). The **Trigger ID** is only the last segment of that URL — the UUID after `/execute/` (e.g. `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`). Copy just that UUID — do not paste the full URL into Order Protection.

    <Tip>
      Copy the Trigger ID before dismissing the pop-up. If you miss it, you can find the URL again in the trigger's **Settings** in Rise.
    </Tip>
  </Step>

  <Step title="Add the Issue Store Credit action">
    In the left nav, click the trigger you just created, then click **Add action** and select **Issue store credit**.
  </Step>

  <Step title="Configure the action">
    Configure the Issue Store Credit action as follows:

    * **Type:** Percentage of
    * **Percentage:** `100%`
    * **of:** `amount` (should auto-populate from the variable you created)
  </Step>

  <Step title="Activate and save">
    In the top right, toggle the workflow to **Active**, then click **Save**.
  </Step>
</Steps>

#### Add the Trigger ID in Order Protection

<Steps>
  <Step title="Open the Rise.ai integration">
    In your Order Protection dashboard, go to **Settings > Integrations** and open the Rise.ai integration.
  </Step>

  <Step title="Paste the Trigger ID">
    Paste the Trigger ID you copied from Rise into the **Trigger ID** field.
  </Step>

  <Step title="Save Configuration" icon="check">
    Click **Save**. Order Protection will now dispatch approved claim credits through your Rise trigger workflow.
  </Step>
</Steps>

## How It Works

Once the integration is configured, the gift card process is fully automated:

### Creating New Gift Cards

**For Claims:**

1. **Claim Approval**: When a support agent approves a claim and selects gift card as the resolution method
2. **Gift Card Creation**: Order Protection automatically creates a gift card in Rise.ai with:
   * The claim amount as the gift card value
   * Customer's email address and name
   * Reference to the original order number
   * Reference to the claim ID for tracking
   * Email subject: "Gift Card for Claim #\[ClaimID]"
3. **Customer Notification**: Rise.ai sends the gift card to the customer's email with a customized message
4. **Gift Card Activation**: The customer receives a gift card code they can use immediately

**For Bonus Store Credit:**

1. **Credit Issuance**: When bonus store credit is triggered (e.g., loyalty rewards, promotions)
2. **Gift Card Creation**: Order Protection creates a gift card with:
   * The specified credit amount
   * Customer's email address and name
   * Reference to the original order number
   * Email subject: "Bonus Store Credit for Order #\[OrderNumber]"
3. **Customer Notification**: Rise.ai sends the bonus credit to the customer

### Updating Existing Gift Cards

For customers with existing Rise.ai loyalty cards:

1. **Balance Check**: Order Protection can retrieve the customer's current gift card balance
2. **Balance Update**: When additional credit is needed, Order Protection adds the amount to the existing card
3. **Type Tracking**: Updates are marked as type "refund" with order reference for accounting

<Tip>
  Gift cards are automatically associated with customer accounts using their customer ID, making it easy for returning customers to access and accumulate their credit.
</Tip>

### Resolution Fallback Order

When a claim is resolved with store credit, Order Protection selects a dispatch path based on your integration configuration:

1. **Rise Trigger workflow** — used first if a **Trigger ID** is configured. Order Protection polls the customer's loyalty card for up to \~4.5 seconds to confirm the credit posted.
2. **Rise Credit API** — used next if a **Credit API Token** is configured and either no Trigger ID is set or the trigger workflow didn't post credit in time.
3. **Native Shopify gift card** — used as the final fallback if neither Rise path is available.

This ordering lets you migrate safely: stores switching to trigger workflows can keep their Credit API Token configured as a safety net.

## Gift Card Information

Each gift card created through this integration includes:

* **Gift Card Code**: Unique code the customer uses at checkout
* **Initial Value**: The claim or credit amount
* **Current Balance**: Available credit (may differ from initial value after partial use)
* **Customer Details**: Email, name, and customer ID (if available)
* **Order Reference**: Links back to the original order
* **Claim Reference**: Links back to the specific claim (for claim-based cards)
* **Expiration**: Based on your Rise.ai settings (optional)
* **Store Domain**: Associated with your specific store
* **Gift Card Type**: Indicates the source (claim resolution, bonus credit, etc.)
* **Collections**: Associated Rise.ai collections for organization

## Additional Features

### Customer Loyalty Cards

Order Protection can retrieve and update existing customer loyalty cards:

* **Retrieve Balance**: Check a customer's current gift card balance before processing
* **Accumulate Credit**: Add amounts to existing cards instead of creating multiple cards
* **Customer History**: Track all gift card activity linked to the customer account

This functionality is particularly useful for:

* Customers with multiple approved claims
* Loyalty program integration
* Preventing duplicate gift cards for the same customer

## Best Practices

<AccordionGroup>
  <Accordion title="Customer Communication">
    Ensure your customers understand:

    * How to check their gift card balance
    * Where to find their gift card code
    * Any expiration dates or usage restrictions
    * How to apply the gift card at checkout
    * That multiple credits may be consolidated into a single loyalty card
  </Accordion>

  <Accordion title="Tracking and Reporting">
    Use Rise.ai's dashboard to:

    * Monitor gift card usage rates
    * Track outstanding gift card balances
    * Identify customers who haven't redeemed their cards
    * Analyze gift card performance over time
    * Review balance update history for customer accounts
  </Accordion>

  <Accordion title="Bonus Store Credit Strategy">
    Consider using bonus store credit for:

    * Customer retention campaigns
    * Loyalty program rewards
    * Referral incentives
    * Apology gestures for service issues
    * First-time customer promotions

    Track the source and performance of different bonus credit campaigns to optimize your strategy.
  </Accordion>
</AccordionGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Gift Card Not Created">
    If a gift card isn't created automatically:

    * Verify your Credit API Token is correct and active
    * Ensure your store domain is properly configured
    * Check that the customer has a valid email address
    * Verify the claim amount is greater than zero

    If issues persist, check the integration status in your settings or contact Order Protection support.
  </Accordion>

  <Accordion title="Customer Didn't Receive Gift Card">
    If a customer reports not receiving their gift card:

    1. Check the customer's spam/junk folder
    2. Verify the email address in the claim is correct
    3. Look up the gift card in your Rise.ai dashboard
    4. Manually resend the gift card from Rise.ai if needed
  </Accordion>

  <Accordion title="Invalid API Token Error">
    If you see an "API key not found" error:

    * Confirm you're using the Credit API Token (not a different API key)
    * Check that the token hasn't expired or been revoked
    * Re-enter the token in Order Protection settings
    * Contact Rise.ai support if the token appears invalid
  </Accordion>

  <Accordion title="Store Domain Not Found">
    If you see a "Store domain not found" error:

    * Verify your store is properly configured in Order Protection
    * Check that your store domain matches your Shopify store URL
    * Ensure the store hasn't been archived or deactivated
    * Contact Order Protection support for assistance
  </Accordion>

  <Accordion title="Gift Card Balance Update Failed">
    If updating an existing gift card balance fails:

    * Verify the gift card ID exists in your Rise.ai dashboard
    * Check that the gift card hasn't expired
    * Ensure the customer ID is correctly linked
    * Verify the additional amount is a valid positive number
    * Contact Rise.ai if the card appears to be locked or restricted
  </Accordion>

  <Accordion title="Service Temporarily Unavailable">
    If you see a "Rise.ai service temporarily unavailable" error:

    * This is typically a transient outage on Rise.ai's side
    * The system will automatically retry in most cases
    * Check Rise.ai's status page for known issues
    * If the issue persists beyond 15 minutes, contact Rise.ai support
  </Accordion>

  <Accordion title="Trigger Workflow Didn't Issue Credit">
    If a configured Rise trigger workflow doesn't issue credit:

    * Confirm the workflow is toggled **Active** in Rise.
    * Verify the Trigger ID in Order Protection matches the trigger in Rise exactly.
    * Check the trigger's variable paths are `email` and `amount` (lowercase) — mismatched paths cause the trigger to receive empty values.
    * If the trigger doesn't post credit within \~4.5 seconds, Order Protection automatically falls back to the Credit API (if configured) or a native Shopify gift card.
  </Accordion>
</AccordionGroup>

## API Details

For developers and technical teams, the integration uses the Rise.ai Credit API v2 with the following endpoints:

### Create Gift Card

**Endpoint:** `POST /v2/gift-cards/issue/`

**Parameters:**

* `shop_url`: Your store domain
* `gift_card.balance`: Gift card amount
* `gift_card.note`: Internal note with claim/order reference
* `email_details.recipient`: Customer name
* `email_details.recipient_email`: Customer email
* `email_details.title`: "Created by Order Protection"
* `email_details.subject`: Customized subject line
* `email_details.body`: Customized email body

**Authentication:** Uses `x-rise-access-token` header with your Credit API Token

### Get Customer Gift Card

**Endpoint:** `GET /v2/gift-cards/`

**Parameters:**

* `shop_url`: Your store domain
* `customer_id`: Shopify customer ID

**Returns:**

* `gift_card_id`: Unique identifier for the loyalty card
* `amount`: Current balance
* `code`: Gift card code
* `expires_on`: Expiration date (if applicable)

### Update Gift Card Balance

**Endpoint:** `PUT /v2/gift-cards/{giftCardId}`

**Parameters:**

* `shop_url`: Your store domain
* `amount`: Additional amount to add
* `type`: "refund" (for tracking purposes)
* `order_id`: Reference order ID

**Configuration:**

* Base URL: `https://application.rise-ai.com` (configurable via `RISE_API_BASE_URL` environment variable)
* Integration Category: "Support"

<Tip>
  The integration is category-tagged as "Support" in Order Protection, making it easy to find among support-related integrations.
</Tip>

## Support

If you need assistance with the Rise.ai integration:

* **Order Protection Support**: Contact our support team through your dashboard
* **Rise.ai Support**: Reach out to your Rise.ai customer support contact
* **API Issues**: Check your API token and store configuration first

## Related Documentation

<CardGroup cols={2}>
  <Card title="Claims API" href="/api-reference/claims/create-online-claim">
    Learn how to create claims programmatically
  </Card>

  <Card title="Webhooks" href="/webhooks/claims/claim-approved">
    Set up webhooks for claim approval events
  </Card>
</CardGroup>