Outbound Webhooks: What information am I sending?

Kayla M.

Updated

Find out the fields sent to your third-party applications when you use Kajabi's Outbound Webhooks.

Note
Webhooks on Kajabi are exclusively accessible for Heroes on the Growth and Pro subscription plans. Learn how to upgrade your Kajabi subscription plan here.

In this article:


Outbound Webhooks

What are outbound webhooks? An Outbound Webhook sends information to a third-party application when an action occurs in Kajabi.

An Outbound Webhook can be used when you would like to send information (including name, email, and transaction information) to a third-party application after a purchase has been made in Kajabi.

Learn how to use webhooks on Kajabi.


Purchase Created Webhooks

The following are the fields sent to your third-party applications when a purchase is made on your site:

Header fields

  • id
    Unique identifier for the transaction.
  • event
    String representing the event type. For example, "purchase.created" occurs whenever a checkout is successful.

Checkout fields

  • member_id
    Unique identifier for the customer who made the purchase.
  • member_email
    The customer's email.
  • member_name
    The customer's full name at the time of checkout.
  • member_first_name
    The customer's first name at the time of checkout.
  • member_last_name
    The customer's last name at the time of checkout.
  • contact_address_line_1
    Customer's address line 1 (e.g., street, PO Box, or company name), if collected at the time of checkout.
  • contact_address_line_2
    Customer's address line 2 (e.g., apartment, suite, unit, or building), if collected at the time of checkout.
  • contact_address_city
    Customer's city, district, suburb, town, or village, if collected at the time of checkout.
  • contact_address_country
    Customer's two-letter country code, if collected at the time of checkout.
  • contact_address_country_name
    Customer's full name of country, if collected at the time of checkout.
  • contact_address_state
    Customer's state, county, province, or region, if collected at the time of checkout.
  • contact_address_zip
    Customer's ZIP or postal code, if collected at the time of checkout.
  • opt_in
    Boolean representing customer opting in to email subscriber list at the time of checkout.
  • custom_field_<fieldname>
    Custom form fields and submitted values at the time of checkout.

Affiliate fields (if applicable)

  • affiliate_conversion_id
    Unique identifier for the affiliate conversion.
  • affiliate_user_id
    Unique identifier for the affiliate user.
  • affiliate_user_name
    Name of affiliate user
  • affiliate_user_email
    Email of affiliate user

Transaction fields

  • transaction_id
    Unique identifier for the transaction.
  • transaction_created_at
    Date and time at which the transaction was created.
  • offer_id
    Unique identifier for the Kajabi Offer that was purchased.
  • offer_title
    The title of the Kajabi Offer that was purchased.
  • offer_type
    Kajabi Offer type. Can be a one-time, subscription, multi-pay, or free Offer.
  • subtotal
    Transaction amount, in currency's smallest currency unit, before discounts and taxes are applied.
  • subtotal_decimal
    Transaction amount before discounts and taxes are applied. Formatted with decimal places if applicable.
  • discount_amount
    Discount amount, if applicable, in currency's smallest currency unity.
  • discount_amount_decimal
    Discount amount, if applicable, in currency's smallest currency unit. Formatted with decimal places if applicable.
  • amount_paid
    Amount paid, in currency's smallest currency unit, after discounts and taxes are applied.
  • amount_paid_decimal
    Amount paid after discounts and taxes are applied. Formatted with decimal places if applicable.
  • currency
    Three-letter ISO currency mode.
  • payment_method
    Payment method used for the transaction. For Kajabi Payments, this detail is more granular, such as visa, mastercard, etc.
  • payment_processor
    Processor used for a particular transaction.
  • coupon_code
    Coupon code, when applicable, used to calculate a discount.

Recurring payment fields (if applicable)

  • subscription_id
    Unique identifier for the new subscription created.
  • subscription_created_at
    Date and time at which the subscription of multiple payment was created.
  • interval_payment_amount
    For recurring payments, this is the amount that is charged at the billing interval.
  • interval
    For recurring payments, this is the billing interval. For example, this can be week for weekly billing.
  • interval_count
    Combined with interval, this is the frequency of billing. For example, interval_count = 2 and interval = week means the customer would be billed every 2 weeks.
  • trial_period_days
    For subscriptions, this is the number of trial days before billing starts. Can be between 1-365 days or null if not relevant.
  • setup_fee
    For recurring payments, this is the amount charged immediately upon purchase. Can be used to create a paid trial.
  • total_payment_count
    For multiple payments, this is the total number of installment payments.
  • interval_payment_amount_decimal
    For recurring payments, this is the amount that is charged at the billing interval. Formatted with decimal places if applicable.
  • setup_fee_decimal
    For recurring payments, this is the amount charged immediately upon purchase. Can be used to create a paid trial. Formatted with decimal places if applicable.

Payment Succeeded Webhooks

The Payment Succeeded webhook is sent upon every successful payment.  This includes one-time payments, and both the initial payment and subsequent recurring payments on subscriptions and multiple payment offers.  The following are the fields within the payload:

Attributes:

  • id
    Unique identifier for the event.
  • Event
    String representing the event type. For example, “payment.succeeded” occurs whenever a payment is successful.

Offer

Offer information associated with the payment at the time of the transaction.

  • id
    Unique Identifier for the Kajabi offer.
  • title
    The title of the Kajabi Offer that was purchased.
  • internal_title
    The internal title of the Kajabi offer that was purchased.
  • type
    Kajabi Offer type. Can be one-time, subscription, multi-pay, or free.

Member

Contact information associated with the payment at the time of transaction.

  • id
    Unique Identifier for the customer’s contact record who made a payment transaction.
  • email
    The contact record’s email address at the time of the payment transaction.
  • name
    The contact record’s full name at the time of the payment transaction.
  • first_name
    The contact record’s first name at the time of the payment transaction.
  • last_name
    The contact record’s last name at the time of the payment transaction.

Payment Transaction

Payment information associated at the time of transaction.

  • Id
    Unique identifier for the transaction.
  • created_at
    Date and time at which the transaction was created.
  • payment_processor
    Processor used for a particular transaction.
  • payment_method
    Payment method used for the transaction.  For Kajabi Payments, this detail is more granular, such as visa, mastercard, etc.
  • sales_tax
    The sales tax, in the currency’s smallest currency unit, included in the transaction.
  • sales_tax_decimal
    The sales tax included in the transaction.  Formatted with decimal places if applicable.
  • currency
    Three-letter ISO currency code.
  • amount_paid
    Amount paid, in currency’s smallest currency unit, after discounts and taxes are applied.
  • amount_paid_decimal
    Amount paid after discounts and taxes are applied.  Formatted with decimal places if applicable.
  • subtotal
    Transaction amount, in currency’s smallest currency unit, before discounts and taxes are applied.
  • subtotal_decimal
    Transaction amount before discounts and taxes are applied.  Formatted with decimal places if applicable.
  • discount_amount
    Discount amount, if applicable, in currency’s smallest currency unit.
  • discount_amount_decimal
    Discount amount, if applicable, in currency’s smallest currency unit.  Formatted with decimal places if applicable.
  • coupon_code
    Coupon code, when applicable, used to calculate a discount.

Recurring payment

Recurring payment information associated with the payment at the time of the transaction.

  • id
    Unique identifier for the recurring payment.  This can either be the subscription ID or multiple payments ID.
  • created_at
    Date and time at which the subscription or multiple payment was created.
  • payment_amount
    Amount, in the currency’s smallest currency unit, that is charged at the billing interval.
  • payment_amount_decimal
    Amount that is charged at the billing interval.  Formatted with decimal places if applicable.
  • interval
    This is the billing interval.  For example, this can be a week for weekly billing.
  • interval_count
    Combined with the interval field, this is the frequency of billing.  For example, interval_count = 2 and interval = week means the customer would be billed every 2 weeks.
  • trial_period_days
    For subscriptions, this is the number of trial days before billing starts.  Can be between 1-365, or null if not relevant.
  • total_payment_count
    For multiple payments, this is the total number of installment payments.
  • payments_made
    For multiple payments, this is the total number of payments made.
  • setup_fee
    This is the amount charged immediately upon purchase. Can be used to create a paid trial.
  • setup_fee_decimal
    This is the amount charged immediately upon purchase. Formatted with decimal places if applicable.

And that's the Outbound Webhooks sent by Kajabi! Please vote below and let us know if you found this article helpful. We value your feedback. Thanks for being the best part of Kajabi!

Did you find this article helpful?

Need more help?

Contact Us