Supported Webhook Events

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.

{
    "event_type": "customer.new",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test3"
    }
}

usage.limit_exceeded

This event is triggered whenever a customer 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)

{
    "event_type": "usage.limit_exceeded",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "meter_name": "api_requests",
        "labels": {"type": "search", "region": "any"}
    }
}

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.

{
    "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.

{
    "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.

{
    "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.

{
    "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.

{
    "event_type": "invoice.update",
    "idempotency_key": "7a8f8655f39193090d47103bc3103f9a",
    "data": {
        "vendor_name": "antler_db_inc",
        "customer_name": "test_customer",
        "invoice_uuid": "55de94bc-0108-44cd-ae01-f94fabec3e0e"
    }
}

Did this page help you?