Supported Webhook Events

29min
This is a list of the current events we support. It includes the name of each type of event, a brief description, and the names and details of all of the properties on their payloads.
Customers
These events are triggered during actions relating to customers.
customer.new
This event is triggered when a customer is created.
Property
Type
Description.
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
Example
JSON
{
    "event_type": "customer.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3"    
    }
}
{
    "event_type": "customer.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3"    
    }
}
﻿
customer.update
This event is triggered when a customer is updated. (E.g., if their contact info changes.)
Property
Type
Description.
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
Example
JSON
{
    "event_type": "customer.update",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3"  
    }
}
{
    "event_type": "customer.update",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3"  
    }
}
﻿
customer.payment_gateway.created
This event is triggered when a customer sets up their payment gateway credentials in Octane. For example, if one of your newly signed customers connects to us through Stripe we will trigger this webhook to your apis.
Property
Type
Description.
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
Example
JSON
{
    "event_type": "customer.payment_gateway.created",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3"    
    }
}
{
    "event_type": "customer.payment_gateway.created",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3"    
    }
}
﻿
customer.payment_method.updated
This event is triggered when a customer changes, adds, or removes their payment information in Stripe.
Property
Type
Description.
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
payment_provider
string
The payment gateway provider (STRIPE or PADDLE)
Example
JSON
{
    "event_type": "customer.payment_method.updated",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3",
        "payment_provider": "STRIPE"    
    }
}
{
    "event_type": "customer.payment_method.updated",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3",
        "payment_provider": "STRIPE"    
    }
}
﻿
usage.limit_exceeded
This event is triggered whenever a customer equals or exceeds the usage limits set on the metered components in their subscription.
Property
Type
Description
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
meter_name
string
The meter's code name.
labels
dict<string, string>
The labels specified on the limit. (empty for an overall limit)
limit
int
The limit that was exceeded.
Example
JSON
{
    "event_type": "usage.limit_exceeded",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "meter_name": "api_requests",
      	"limit": 10,
        "labels": {"type": "search", "region": "any"}
    }
}
{
    "event_type": "usage.limit_exceeded",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "meter_name": "api_requests",
      	"limit": 10,
        "labels": {"type": "search", "region": "any"}
    }
}
﻿
usage.limit_approached
This event is triggered whenever a customer equals or exceeds the 50%, 70% and 90% thresholds of a usage limit set on the metered components in their subscription.
Property
Type
Operation
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
meter_name
string
The meter's code name.
labels
dict<string, string>
The labels specified on the limit. (empty for an overall limit)
limit
int
The limit that was exceeded.
threshold
int
The % threshold of the limit that was approached.
Example
JSON
{
    "event_type": "usage.limit_approached",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "meter_name": "api_requests",
        "labels": {"type": "search", "region": "any"},
      	"limit": 10,
      	"threshold": 50    
    }
}
{
    "event_type": "usage.limit_approached",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "meter_name": "api_requests",
        "labels": {"type": "search", "region": "any"},
      	"limit": 10,
      	"threshold": 50    
    }
}
﻿
Subscriptions
These events are triggered during actions relating to subscriptions.
subscription.new
This event is triggered when a subscription is created. We create a subscription any time a customer is subscribed to a price plan. This event fires regardless of whether the subscription starts now or in the future.
Property
Type
Description
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
subscription_effective_at
string
The effective date for the subscription, formatted as an ISO string.
Example
JSON
{
    "event_type": "subscription.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "subscription_effective_at": "2022-03-14T21:03:33.913000"    
    }
}
{
    "event_type": "subscription.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "subscription_effective_at": "2022-03-14T21:03:33.913000"    
    }
}
﻿
subscription.update
This event is triggered when a subscription is updated. This event fires regardless of whether the subscription is updated in-place or updated to a new price plan.
Example
JSON
{
    "event_type": "subscription.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "subscription_effective_at": "2022-03-14T21:03:33.913000"    
    }
}
{
    "event_type": "subscription.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "subscription_effective_at": "2022-03-14T21:03:33.913000"    
    }
}
﻿
subscription.change
This event is triggered when a customer's subscription actually changes, i.e., the date for which the subscription change is scheduled.
Example
JSON
{
    "event_type": "subscription.change",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
    }
}
{
    "event_type": "subscription.change",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
    }
}
﻿
Invoices
These events are triggered during actions relating to invoices.
invoice.new
This event is triggered when an invoice is generated within Octane. We generate an invoice regularly based on the price plan period on the customer's subscription. This event does not indicate that the invoice has been sent to the customer/has been paid.
Property
Type
Description
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
invoice_uuid
string
The UUID of the invoice generated within Octane.
Example
JSON
{
    "event_type": "invoice.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "invoice_uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e"    
    }
}
{
    "event_type": "invoice.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "invoice_uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e"    
    }
}
﻿
invoice.update
This event is triggered whenever any field on a previously generated invoice is updated. This event is useful helpful to listen to for any changes to invoice statuses.
Property
Type
Description
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
invoice_uuid
string
The UUID of the updated invoice.
Example
JSON
{
    "event_type": "invoice.update",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "invoice_uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e"    
    }
}
{
    "event_type": "invoice.update",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "invoice_uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e"    
    }
}
﻿
Payments
These events are triggered during actions relating to payments.
payment.new
This event is triggered when a payment is attempted within Octane.
Property
Type
Description
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
success
boolean
The UUID of the invoice generated within Octane.
attempted_at
string
The timestamp that the payment was attempted, formatted as an ISO string.
error_str
string
The error string associated with a failed payment. Empty is success is True.
topoff_immediate_charge_attempt_count
integer
The number of payment attempts made. Only applicable for credit top off plans with immediate charging enabled.
Example
JSON
{
    "event_type": "payment.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "success": False,
        "attempted_at":"2023-09-12 15:51:29.028635",
        "error_str": "Failed to process Stripe payment: Request req_8Jc5pIWahueSTI: Your card was declined.",
        "topoff_immediate_charge_attempt_count": 4    
    }
}
{
    "event_type": "payment.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "success": False,
        "attempted_at":"2023-09-12 15:51:29.028635",
        "error_str": "Failed to process Stripe payment: Request req_8Jc5pIWahueSTI: Your card was declined.",
        "topoff_immediate_charge_attempt_count": 4    
    }
}
﻿
Credits
customer.credit_threshold_exceeded
This event is triggered whenever the credit balance of a customer dips below the threshold on their credit top off plan or 0 (if there is not credit top off plan associated with the customer). This event will be triggered once when the balance drops below the trigger amount and will not be triggered again until after a credit grant is issued against that customer.
Example
JSON
{
    "event_type": "customer.credit_threshold_exceeded",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
       	"credit_trigger_amount":0,
    }
}
{
    "event_type": "customer.credit_threshold_exceeded",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
       	"credit_trigger_amount":0,
    }
}
﻿
credit_grant.new
This event is triggered whenever a credit grant is created.
Property
Type
Description
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
uuid
string
The UUID of the credit grant created within Octane.
amount
number
The amount of credits granted.
price
int
Price paid for the credit grant in the lowest denomination (i.e cents)
source
string
Reason the grant was created (i.e ONE_TIME_GRANT, TOP_OFF_GRANT, CREDIT_REFUND, or CREDIT_PLAN_GRANT)
effective_at
string
Start date time of the grant in ISO 8601 format
expires_at
string
Expiration date time of the grant in ISO 8601 format. Null for permanent grants.
Example
JSON
{
    "event_type": "credit_grant.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
       	"uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e",
        "amount": 500,
        "price": 50000,
        "source": 'ONE_TIME_GRANT',
        "effective_at": "2023-07-10T16:23:40.803557",
        "expires_at": "2024-07-10T16:23:40.803557"    
    }
}
{
    "event_type": "credit_grant.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
       	"uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e",
        "amount": 500,
        "price": 50000,
        "source": 'ONE_TIME_GRANT',
        "effective_at": "2023-07-10T16:23:40.803557",
        "expires_at": "2024-07-10T16:23:40.803557"    
    }
}
﻿
credit_grant.granted
This event is triggered whenever a credit grant is actually granted to the customer (i.e., added to the credit ledger).
Property
Type
Description
vendor_name
string
The vendor's code name.
customer_name
string
The customer's code name.
uuid
string
The UUID of the credit grant created within Octane.
amount
number
The amount of credits granted.
price
int
Price paid for the credit grant in the lowest denomination (i.e cents)
source
string
Reason the grant was created (i.e ONE_TIME_GRANT, TOP_OFF_GRANT, CREDIT_REFUND, or CREDIT_PLAN_GRANT)
effective_at
string
Start date time of the grant in ISO 8601 format
expires_at
string
Expiration date time of the grant in ISO 8601 format. Null for permanent grants.
Example
JSON
{
    "event_type": "credit_grant.granted",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
       	"uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e",
        "amount": 500,
        "price": 50000,
        "source": 'ONE_TIME_GRANT',
        "effective_at": "2023-07-10T16:23:40.803557",
        "expires_at": "2024-07-10T16:23:40.803557"    
    }
}
{
    "event_type": "credit_grant.granted",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
       	"uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e",
        "amount": 500,
        "price": 50000,
        "source": 'ONE_TIME_GRANT',
        "effective_at": "2023-07-10T16:23:40.803557",
        "expires_at": "2024-07-10T16:23:40.803557"    
    }
}
﻿
﻿
Spend
spend.threshold_approached
This event is triggered whenever the customer's spend in the current billing cycle equals or exceeds 50%, 70% and 90% of the spend threshold set for the customer. The threshold can be set with this API.
Example
JSON
{
  "event_type": "spend.threshold_approached",
  "idempotency_key": "a6eb250de28acd108d547e057e48077a",
  "data": {
    "vendor_name": "vendor_name",
    "customer_name": "customer_name",
    "threshold_amount": 10000,
    "threshold_percentage": 90,
    "trigger_amount": 12000
  }
}
{
  "event_type": "spend.threshold_approached",
  "idempotency_key": "a6eb250de28acd108d547e057e48077a",
  "data": {
    "vendor_name": "vendor_name",
    "customer_name": "customer_name",
    "threshold_amount": 10000,
    "threshold_percentage": 90,
    "trigger_amount": 12000
  }
}
﻿
spend.threshold_exceeded
This event is triggered whenever the customer's spend in the current billing cycle equals or exceeds the spend threshold set for the customer. The threshold can be set with this API.
Example
JSON
{
  "event_type": "spend.threshold_exceeded",
  "idempotency_key": "d6a5db3a68a7a4f25a4b5090f169a174",
  "data": {
    "vendor_name": "vendor_name",
    "customer_name": "customer_name",
    "trigger_amount": 12000
  }
}
{
  "event_type": "spend.threshold_exceeded",
  "idempotency_key": "d6a5db3a68a7a4f25a4b5090f169a174",
  "data": {
    "vendor_name": "vendor_name",
    "customer_name": "customer_name",
    "trigger_amount": 12000
  }
}
﻿
﻿
Handling Webhook Events
Accepting Payment Methods in your UI
Property	Type	Description.
vendor_name	string	The vendor's code name.
customer_name	string	The customer's code name.
Property	Type	Description
vendor_name	string	The vendor's code name.
customer_name	string	The customer's code name.
meter_name	string	The meter's code name.
labels	dict<string, string>	The labels specified on the limit. (empty for an overall limit)
limit	int	The limit that was exceeded.
Property	Type	Operation
vendor_name	string	The vendor's code name.
customer_name	string	The customer's code name.
meter_name	string	The meter's code name.
labels	dict<string, string>	The labels specified on the limit. (empty for an overall limit)
limit	int	The limit that was exceeded.
threshold	int	The % threshold of the limit that was approached.
Supported Webhook Events

Customers

customer.new

customer.update

customer.payment_gateway.created

customer.payment_method.updated

usage.limit_exceeded

usage.limit_approached

Subscriptions

subscription.new

subscription.update

subscription.change

Invoices

invoice.new

invoice.update

Payments

payment.new

Credits

customer.credit_threshold_exceeded

credit_grant.new

credit_grant.granted

﻿

Spend

spend.threshold_approached

spend.threshold_exceeded
