v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB

Events

List Notification Events

Retrieve a list of Notification Event Types.

This endpoint retrieves a list of Event Types that can have Notification rules configured.

get/organizations/{orgId}/events/types

Path parameters

orgIdstring required

The unique identifer (UUID) of the Organization. The Organization represents your company as a direct customer of our service.

Response

Returns the list of Event Types that can have Notification rules configured

eventsstring[]

An array containing a list of all Event Types for which Notification rules can be configured. Each Event Type is represented by a string.

Example response

{
  "events": [
    "billing.balance.created",
    "billing.balance.deleted",
    "billing.balance.updated",
    "billing.balanceamount.created",
    "billing.balanceamount.deleted",
    "billing.balanceamount.updated",
    "billing.bill.created",
    "billing.bill.deleted",
    "billing.bill.updated",
    "billing.billconfig.created",
    "billing.billconfig.deleted",
    "billing.billconfig.updated",
    "billing.billjob.created",
    "billing.billjob.deleted",
    "billing.billjob.updated",
    "billing.charge.created",
    "billing.charge.deleted",
    "billing.charge.updated",
    "billing.counteradjustment.created",
    "billing.counteradjustment.deleted",
    "billing.counteradjustment.updated",
    "billing.scheduledbalancecharge.created",
    "billing.scheduledbalancecharge.deleted",
    "billing.scheduledbalancecharge.updated",
    "billing.scheduledbalancetransaction.created",
    "billing.scheduledbalancetransaction.deleted",
    "billing.scheduledbalancetransaction.updated",
    "billing.statementjob.created",
    "billing.statementjob.deleted",
    "billing.statementjob.updated",
    "configuration.account.created",
    "configuration.account.deleted",
    "configuration.account.updated",
    "configuration.accountplan.created",
    "configuration.accountplan.deleted",
    "configuration.accountplan.updated",
    "configuration.aggregation.created",
    "configuration.aggregation.deleted",
    "configuration.aggregation.updated",
    "configuration.alert.created",
    "configuration.alert.deleted",
    "configuration.alert.updated",
    "configuration.commitment.created",
    "configuration.commitment.deleted",
    "configuration.commitment.updated",
    "configuration.compoundaggregation.created",
    "configuration.compoundaggregation.deleted",
    "configuration.compoundaggregation.updated",
    "configuration.contract.created",
    "configuration.contract.deleted",
    "configuration.contract.updated",
    "configuration.counter.created",
    "configuration.counter.deleted",
    "configuration.counter.updated",
    "configuration.counterpricing.created",
    "configuration.counterpricing.deleted",
    "configuration.counterpricing.updated",
    "configuration.creditreason.created",
    "configuration.creditreason.deleted",
    "configuration.creditreason.updated",
    "configuration.customfield.created",
    "configuration.customfield.deleted",
    "configuration.customfield.updated",
    "configuration.meter.created",
    "configuration.meter.deleted",
    "configuration.meter.updated",
    "configuration.metergroup.created",
    "configuration.metergroup.deleted",
    "configuration.metergroup.updated",
    "configuration.organization.created",
    "configuration.organization.deleted",
    "configuration.organization.updated",
    "configuration.organizationconfig.created",
    "configuration.organizationconfig.deleted",
    "configuration.organizationconfig.updated",
    "configuration.plan.created",
    "configuration.plan.deleted",
    "configuration.plan.updated",
    "configuration.plangroup.created",
    "configuration.plangroup.deleted",
    "configuration.plangroup.updated",
    "configuration.plangrouplink.created",
    "configuration.plangrouplink.deleted",
    "configuration.plangrouplink.updated",
    "configuration.plantemplate.created",
    "configuration.plantemplate.deleted",
    "configuration.plantemplate.updated",
    "configuration.pricing.created",
    "configuration.pricing.deleted",
    "configuration.pricing.updated",
    "configuration.pricingband.created",
    "configuration.pricingband.deleted",
    "configuration.pricingband.updated",
    "configuration.product.created",
    "configuration.product.deleted",
    "configuration.product.updated",
    "configuration.transactiontype.created",
    "configuration.transactiontype.deleted",
    "configuration.transactiontype.updated",
    "dataexport.job.failure",
    "ingest.validation.failure",
    "integration.authentication.error",
    "integration.disabled.error",
    "integration.missingaccountmapping.error",
    "integration.perform.error",
    "integration.validation.error"
  ]
}