Odeum's Zapier Integration

Overview and data details about how to use Zapier to send data from Odeum to your platform of choice

Jay Dysart avatar
Written by Jay Dysart
Updated over a week ago

Zapier is an integration service that enables data exchange between thousands of apps and platforms, including Odeum.

Setup

To set up Odeum in Zapier, you will need your unique API Key, which you can find in Account > API Keys in the Odeum Dashboard.

Using this API Key, you can create a new Zapier integration from Odeum's page in Zapier: https://zapier.com/apps/odeum/integrations

Odeum Event Triggers

When events take place in the Odeum platform, a Zapier "trigger" event is fired and data is sent into Zapier. This data can then be pushed into other apps.

Our Odeum Zapier integration currently supports the following triggers:

  • Sign Up - Triggers when a new user signs up for a subscription to your Odeum channel. This includes free trials.

  • Subscription conversion to paid - Triggers when a user converts their subscription to paid.

  • Subscription ended - Triggers when a user's subscription ends due to cancellation or non-payment

  • Subscription renewal - Triggers when a user pays for their subscription renewal

  • Email Opt In - Triggers when a user opts in to marketing email communications

  • Email Opt Out - Triggers when a user opts out of marketing email communications

Odeum Event Data Overview

Definitions:

  • User - The actual subscriber to your Odeum Channel.

  • Subscription - The current or most recent Subscription that the User had to your Odeum Channel.

  • Subscription Plan - This is the Plan that a publisher creates in the Odeum Dashbooard in Distribution > Subscription Plans that the Subscription for the User is tied to.

  • Most Recent Charge - This is the most recent actual credit card charge for the Subscription.

  • User Email Preference - All users are considered eligible to be emailed through Odeum's Email Marketing features from the time of sign up. The user may be opted out of receiving these emails by one of these methods:

    • User may un-check the "Receive Email Announcements and Updates" checkbox on the website or apps.

    • User may click the "unsubscribe" link at the bottom of marketing emails sent through Odeum.

    • Manager may click the "unsubscribe" link on the Subscriber record in the Odeum Dashboard in Activity > Subscriber List > Subscriber Details

Odeum Event Data Details

All triggers will send the following data to Zapier.

Item

Example

Notes

User ID

"245"

This is a unique id number for the user.

User Name

"John Doe"

The user's full name.

User Email

The user's email address.

Subscription ID

"224"

A unique ID for the User's Subscription.

Subscription Status

"Active"

The current status of the User's Subscription.

Subscription Activated

"2020-09-02 12:06:21"

The date and time that the User's Subscription was activated.

Subscription Trial End

"2020-09-02 12:06:21"

The date and time that the User's Free Trial ended or will end in the future.

Subscription Ended

"0000-00-00 00:00:00", "2020-09-02 12:06:21"

The date and time that the User's Subscription ended. (Will be all zeros if their subscription is active.)

Subscription Cancel At Period End

true, false

If a user has cancelled their subscription, but it remains active until the end of their paid period, this value will be true.

Subscription > Subscription Plan ID

"14"

The unique ID number of the Subscription Plan (found in the Dashboard in Distribution > Subscription Plans)

Subscription > Subscription Plan Name

"Monthly Plan"

The name of the Subscription Plan as configured by the Publisher in Distribution > Subscription Plans

Subscription > Subscription Plan Interval

"month"

The interval of the Subscription Plan

Subscription > Subscription Plan Amount

"299"

The cost of the Subscription Plan per-interval in cents.

Subscription > Subscription Plan Display Price

"$2.99/Mo"

The displayed price of the Subscription Plan as it appears to a user.

Subscription > Subscription Plan Trial Period Days

"3"

The Free Trial period of the Subscription Plan

Most Recent Charge Amount

"299"

The amount in cents of the most recent charge to this user's subscription.

Most Recent Charge Amount Pretty

"$2.99"

The USD currency formatted representation of the most recent charge.

Most Recent Charge Date

"2020-10-06"

The date of the most recent charge.

User Email Preference Unsubscribed

true, false

If the user has unsubscribed from marketing emails, this value will be true. The default is false for all users from the time they sign up.

User Email Preference Unsubscribed Date

"2020-09-02 12:06:21"

This is the date and time of the most recent change to the Email Preference.

Additional Data Points available:

Item

Example

Notes

User Created

"2020-09-02 12:06:21"

This is the date and time of when this User first was created in Odeum.

User Modified

"2020-09-02 12:06:21"

This is the last date and time any modification was made to this User's data record.

Subscription Created

"2020-09-02 12:06:21"

This is the date and time that the Subscription record was created in Odeum's database. This may not be the same as the date and time that the user activated the Subscription.

Subscription Modified

"2020-09-02 12:06:21"

The date and time of the last modification to the Subscription data record.

Subscription > Subscription Plan Status

"live"

The status of the Subscription Plan as determined in Distribution > Subscription Plans.

Subscription > Subscription Plan Created

"2020-09-02 12:06:21"

The date and time that the Subscription Plan was created by a publisher in Distribution > Subscription Plans

Subscription > Subscription Plan Modified

"2020-09-02 12:06:21"

The date and time of the most recent modification to the Subscription Plan

Did this answer your question?