Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure notifications for the App in Zuora

Learn how to configure notifications for billing events in Zuora, including setting up notification settings, delivery options, and callout authentication.

  1. Navigate to Extension Studio > Events & Notifications in the left navigation menu in the Zuora UI.
  2. Locate the Completed Status notification defined on the Billing Run Completion event and click the Edit icon.
  3. Complete the Notification settings and click Save.
    • Basic Information:

      • Name: Completed Status

      • Description: Can be changed for easier identification.

      • Active: Enable to activate the notification.

    • Event Parameters:

      • Bill Run Status: Completed

    • Delivery Options:

      • Email: Do not enable.

      • Callout: Enable

      • Base URL: Enter the Bill Run Complete Callout URL from the Enhanced Invoice Numbering app. On the landing page of the app, select Options > API Token and copy the URL displayed in the Bill Run Complete Callout URL field.

        Bill Run Complete Callout URL in Invoice Numbering API
  4. Click Add Parameter to add a new parameter.
    • Parameter Name: BillRunID

    • Parameter Value: Select BillRun.ID under Legacy Fields.

    • HTTP Method: GET

    • Retry: Do not enable.

    • Callout Authentication: Enable

      • Username: Enter your Zuora username.

      • Password: Enter the API Token from the app.

    On the landing page of the app, select Options > API Token and copy the API token displayed in the API Token field.

  5. Optional: If an invoice is generated outside of a bill run, you must also configure the notification settings for Invoice Posted │Invoice Posted via API.
    • Basic Information:

      • Name: Invoice Posted via API

      • Description: Can be changed for easier identification.

      • Active: Enable to activate the notification.

    • Event Parameters:

      • Trigger event: API

    • Delivery Options:

      • Email: Do not enable.

      • Callout: Enable

      • Base URL - Enter the Invoice Posted Callout URL from the Enhanced Invoice Numbering app. On the landing page of the app, select Options > API Token and copy the URL displayed in the Invoice Posted Callout URL field.

  6. Click Add parameter to add a new parameter.
    • Parameter Name: invoice_id

    • Parameter Value: Select Invoice.ID under Legacy fields.

    • HTTP Method: GET

    • Retry: Do not enable.

    • Callout Authentication: Enable

      • Username: Enter your Zuora username.

      • Password: Enter the API Token from the app.

    On the landing page of the app, select Options > API Token and copy the API token displayed in the API Token field.