Svix

Kable Webhook Event Types

This is the list of event types that we currently send. For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

credit.balance.below

A customer's credit balance has dropped below a given threshold.

Example
JSON
{
  "name": "Credits Consumed",
  "alertId": "alt_a404cbea85f24a96a20760a4f7ee5400",
  "message": "You've used all of your credits for the month",
  "clientId": "yourcompanyuser_1234567890",
  "metadata": {
    "foo": "bar",
    "yourKey": "yourValue"
  },
  "severity": "MEDIUM",
  "eventType": "credit.balance.below",
  "threshold": 0,
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}

customer.bundles.added

A bundle was added to a customer on Kable.

Example Customer Bundle
JSON
{
  "plans": [
    {
      "name": "Requests Usage Plan",
      "planId": "pln_a23e148584d0463482c961b7f62f824c",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_plan123"
    }
  ],
  "status": "ACTIVE",
  "bundles": [
    {
      "name": "Starter Bundle",
      "bundleId": "bun_23c523326c694beca15f9657a1ff9f1a",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_bundle456"
    }
  ],
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "customer.plans.added",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}

customer.bundles.removed

A bundle was removed from a customer on Kable.

Example Customer Bundle
JSON
{
  "plans": [
    {
      "name": "Requests Usage Plan",
      "planId": "pln_a23e148584d0463482c961b7f62f824c",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_plan123"
    }
  ],
  "status": "ACTIVE",
  "bundles": [
    {
      "name": "Starter Bundle",
      "bundleId": "bun_23c523326c694beca15f9657a1ff9f1a",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_bundle456"
    }
  ],
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "customer.plans.added",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}

customer.cancelled

A customer was cancelled on Kable.

Example Customer
JSON
{
  "plans": [
    {
      "name": "Requests Usage Plan",
      "planId": "pln_a23e148584d0463482c961b7f62f824c",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_plan123"
    }
  ],
  "status": "ACTIVE",
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "customer.cancelled",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}

customer.created

A customer was created on Kable.

Example Customer
JSON
{
  "plans": [
    {
      "name": "Requests Usage Plan",
      "planId": "pln_a23e148584d0463482c961b7f62f824c",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_plan123"
    }
  ],
  "status": "ACTIVE",
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "customer.created",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}

customer.plans.added

A plan was added to a customer on Kable.

Example Customer Plan
JSON
{
  "plans": [
    {
      "name": "Requests Usage Plan",
      "planId": "pln_a23e148584d0463482c961b7f62f824c",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_plan123"
    }
  ],
  "status": "ACTIVE",
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "customer.plans.added",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}

customer.plans.removed

A plan was removed from a customer on Kable.

Example Customer Plan
JSON
{
  "plans": [
    {
      "name": "Requests Usage Plan",
      "planId": "pln_a23e148584d0463482c961b7f62f824c",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_plan123"
    }
  ],
  "status": "ACTIVE",
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "customer.plans.removed",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}

customer.updated

A customer was updated on Kable.

Example Customer
JSON
{
  "plans": [
    {
      "name": "Requests Usage Plan",
      "planId": "pln_a23e148584d0463482c961b7f62f824c",
      "metadata": {
        "foo": "bar"
      },
      "externalId": "yourcompany_plan123"
    }
  ],
  "status": "ACTIVE",
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "customer.updated",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}

invoice.created

An invoice was created for a customer on Kable.

Example Invoice
JSON
{
  "status": "PENDING",
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "invoice.created",
  "invoiceId": "inv_1b2c1f27456e48f78f8d902d5da97fbf",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE",
  "totalAmount": 254.86
}

invoice.paid

An invoice was paid for a customer on Kable.

Example Invoice
JSON
{
  "status": "PAID",
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "invoice.paid",
  "invoiceId": "inv_1b2c1f27456e48f78f8d902d5da97fbf",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE",
  "totalAmount": 254.86
}

invoice.payment_failed

An invoice payment failed for a customer on Kable.

Example Invoice
JSON
{
  "status": "FAILED",
  "clientId": "yourcompanyuser_1234567890",
  "currency": "USD",
  "eventType": "invoice.payment_failed",
  "invoiceId": "inv_1b2c1f27456e48f78f8d902d5da97fbf",
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "companyName": "Awesome Corp",
  "environment": "LIVE",
  "totalAmount": 254.86
}

usage.exceeded

A customer's usage has exceeded a given threshold.

Example
JSON
{
  "name": "Message Quota Approaching",
  "alertId": "alt_a404cbea85f24a96a20760a4f7ee5400",
  "message": "You've used 80% of your messages for the month",
  "clientId": "yourcompanyuser_1234567890",
  "metadata": {
    "foo": "bar",
    "yourKey": "yourValue"
  },
  "severity": "MEDIUM",
  "dimension": {
    "key": "messageId",
    "name": "Message",
    "dimensionId": "dim_c5f32b8cd8934356b5167a3b2c6c6314"
  },
  "eventType": "usage.exceeded",
  "threshold": 10000,
  "customerId": "cus_8276e1ac8ed84d21c64f31ae0082fe",
  "aggregation": "COUNT",
  "companyName": "Awesome Corp",
  "environment": "LIVE"
}