# Zapier Integration

Watch our video below, or follow our step by step instruction on setting up the Subrise Subscription app with your Zapier account.

{% embed url="<https://www.loom.com/share/ee7f35e0a7284a63b31249c41c622110?sid=8b5205a6-ced1-4b5e-80ab-40332d9b6102>" %}

## Log into your Existing Zapier Account or Create one

### Create a new Zap

<figure><img src="/files/RJVPGJMMBdHzjofS1FwV" alt=""><figcaption><p>Once logged in Click "Create" and then click "Zaps"</p></figcaption></figure>

### Select a Trigger for you Zap

<figure><img src="/files/wmI4GuTxHicHMWGS3PHj" alt=""><figcaption><p>Choose Trigger an Event that Starts the Zap</p></figcaption></figure>

### Select Webhook as your Trigger type

<figure><img src="/files/jqzOhhEGiYWhfhCpQhVO" alt=""><figcaption><p>Select "Webhook"</p></figcaption></figure>

### Select and "Event", and choose "Catch Hook" as the option.

<figure><img src="/files/HLaKHORwI96M9F7O6joP" alt=""><figcaption><p>"Catch Hook"</p></figcaption></figure>

### Copy the Webhook URL

<figure><img src="/files/IM1c3bZCugsVvWx6NsQ9" alt=""><figcaption><p>Copy the webhook URL, and pase into Subrise App Integration</p></figcaption></figure>

### Paste Webhook Url into Subrise Subscription App

<figure><img src="/files/1Hs7ALLe7D25jIbLzKmV" alt=""><figcaption><p>Paste your webhook url, and click "Connect" or "Update" to connect the app to Zapier</p></figcaption></figure>

### Get the Subrise Data sent to your Zapier Account

<figure><img src="/files/3mVhUwaTP7rvtFuHhbcI" alt=""><figcaption><p>Congrats You're now getting Subrise Data</p></figcaption></figure>

## Event Types and Payloads

The Subrise Subscription application, will send subscription-based data to your Zapier 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/zapier-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.
