--- title: "Create an event trigger" method: POST path: "/events/event-triggers" tags: ["Custom Event Triggers"] --- # Create an event trigger `POST /events/event-triggers` When you create an event trigger, you must specify the base object and define the trigger condition. ### Specify the base object Use `baseObject` field to specify which object to define a trigger on. You can define an event trigger on any of the following objects: * Account * AccountingCode * AccountingPeriod * Amendment * BillingRun * Contact * CreditBalanceAdjustment * CreditMemo * CreditMemoApplication * CreditMemoApplicationItem * CreditMemoItem * CreditMemoPart * DebitMemo * DebitMemoItem * DeliveryAdjustment * Feature * Fulfillment * Fund * Invoice * InvoiceAdjustment * InvoiceItem * InvoiceItemAdjustment * JournalEntry * JournalEntryItem * Order * OrderAction * OrderLineItem * Payment * PaymentApplication * PaymentMethod * PaymentPart * PaymentSchedule * PaymentScheduleItem * Product * ProductFeature * ProductRatePlan * ProductRatePlanCharge * ProductRatePlanChargeTier * RatePlan * RatePlanCharge * RatePlanChargeTier * RatingResult * Refund * RefundApplication * RefundPart * RevenueEvent * RevenueEventItem * RevenueSchedule * RevenueScheduleItem * Subscription * SubscriptionChargeDeliverySchedule * SubscriptionChargePriceInterval * SubscriptionChargePriceIntervalTier * SubscriptionOffer * SubscriptionProductFeature * TaxationItem * UpdaterDetail * Usage * ValidityPeriodSummary In addition to the above Zuora standard objects, you can also use custom objects as base objects for custom events. #### Tenant level base objects and tenant level event triggers Zuora identifies the following base objects and custom objects as the tenant level base objects: * AccountingCode * AccountingPeriod * BillingRun * Feature * JournalEntry * JournalEntryItem * Product * ProductFeature * ProductRatePlan * ProductRatePlanCharge * ProductRatePlanChargeTier Event triggers defined on tenant level base objects are tenant level event triggers. Notifications associated with tenant level events are system notifications. **Note:** Tenant level event triggers and system notifications are only available in the default profile. ### Define the trigger condition The `condition` field is a [JEXL](http://commons.apache.org/proper/commons-jexl/) expression that specifies when to trigger events. The expression can contain fields from the object that the trigger is defined on. **Note:** The condition cannot contain fields from [data source](https://docs.zuora.com?resourceId=platform-export-zoql) objects that are joined to the object that the trigger is defined on. For example, the following condition causes an event to be triggered whenever an invoice is posted with an amount greater than 1000: ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0``` Where: * `changeType` is a keyword that specifies the type of change that occurred to the Invoice object. For all objects, the supported values of `changeType` are `INSERT`, `UPDATE`, and `DELETE`. * `Invoice.Status` is the value of the Invoice object's `Status` field after the change occurred. * `Invoice.Status_old` is the value of the Invoice object's `Status` field before the change occurred. In the above example, the value of `baseObject` is `Invoice`. #### Limitations This event trigger has the following limitations: * Base object values for Zuora standard objects are case sensitive. For example, `PaymentMethod` is correct, and `Paymentmethod` or `paymentmethod` is incorrect. * Base object values for custom objects must be lowercase. For example, `default__vehicle`. * The INSERT change type is not supported on RatePlan base objects. * The INSERT change type is not supported on SubscriptionProductFeature base objects. * When creating custom events, you cannot match fields of the RatePlanCharge object against constant values for the `condition` field. For example, the following condition will cause errors: `RatePlanCharge.ShippingProcessStatus__c == 'Shipping Confirmed'`, where `Shipping Confirmed` is a constant value. * Fields on objects are case-sensitive. For example, `PaymentMethod.createdbyid` can result in errors. The correct format is `PaymentMethod.CreatedById`. * A condition cannot contain fields from data source objects that are joined to the base object. * Do not create duplicate events because they will be either merged or deleted. Zuora considers events that have the same trigger condition as duplicate events, regardless of event type names. See [Custom Events](https://docs.zuora.com?resourceId=platform-custom-event-overview) for more information. ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Track-Id` string ## Request body - PostEventTriggerRequest - `active` boolean, required — The status of the event trigger. - `baseObject` string, required — The base object that the trigger rule is defined upon. The format of the value in this field depends on the base object type: - Standard object: object name, which should follow the pattern ^[A-Z][\w\-]*$. For example, `Invoice`. - Custom object: `default__`. For example, `default__vehicle`. - `condition` string, required — The JEXL expression to be evaluated against object changes. See above for more information and an example. - `description` string — The description of the event trigger. - `eventType` EventType, required - `description` string — The description of the event type. - `displayName` string, required — The display name for the event type. - `name` string, required — The name of the event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$ ## Response `200` OK - EventTrigger - `active` boolean — The status of the trigger. - `baseObject` string — The base object that the trigger rule is defined upon. The format of the value in this field depends on the base object type: - Standard object: object name, which should follow the pattern ^[A-Z][\w\-]*$. For example, `Invoice`. - Custom object: `default__`. For example, `default__vehicle`. - `condition` string — The JEXL expression to be evaluated against object changes. See above for more information and an example. - `description` string — The description of the trigger. - `eventType` EventType - `description` string — The description of the event type. - `displayName` string, required — The display name for the event type. - `name` string, required — The name of the event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$ - `id` string, uuid ## Other responses - `400` — Bad Request - `500` — Server Error --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)