Manage integration events

Any time that customers make a change that affects one of your products, an integration event is logged. These changes include new subscriptions, subscription changes, user assignment changes, cancellations, and so on.

Events are sent to the vendor, who is expected to consume the events as described in User event notification flow and Subscription event notification flow.

Events can be complete, pending, or failed:

• Events are complete after vendors consume them either through an API or manually.
• Events are pending after they are generated and sent to the vendor, but before the vendor consumes them. Events remain in pending status if they require manual resolution or if there is a problem with the vendor.
• Events can fail for several reasons, for example if an operation is canceled or a vendor cannot process an event.

Consumed events remain in the event log for one year, and are automatically removed afterward.

To view integration events

1. Go to Manage > Billing and Distribution > Integration Events. The Integration Events log page opens, with a list of all logged events. The table contains the following information:
   • Status—Indicates whether the event was completed (green), is pending (yellow), or failed (red).
   • Created On—The date and time at which the event (subscription, assignment change, or other) occurred.
   • Marketplace—The name of the marketplace from which the product was purchased.
   • Application—The name of the application for which the event log was created. You can click a link in the Application column to display the product's profile page.
   • Event Type and Event Token—Displays both the event type and the event token. You can click the event token link to view the event document tree in XML format. The XML displays the payload that you receive when the event occurs.
   • Error Code and Message—When an event fails, an error code identifies the cause of the error. Events can also generate messages that contain information about the event, such as whether the event was consumed, whether the event was asynchronous, and so on.
   • User and Company—Displays the name of the user who owns the application and the user's company name. You can click the user's name to send them an email.
   • Published App?—Indicates whether the application is published.
   • Manually Resolved?—After an event that required manual intervention is completed (resolved), the letter Y appears in this column. N/A appears in this column until the event is resolved.
   • Identifiers (account, user, generic)—This column displays the company's account ID (the user's company ID that is used by the vendor), the user account ID (the end user's ID that is used by the vendor), and generic (optional vendor ID of an API result).
2. (Optional) To find a specific event, type a search term in the Search field, such as the user's name, email address, the application name, company name, token, or account identifier.
3. (Optional) To use filters to refine the list of events, click Show Filter. Select any combination of the available filters.
4. (Optional) To download a CSV version of the events table, click Download CSV.

📝 Note: You can also view integration events by creating an Event Integration report at Manage > Billing and Distribution > Reports | Reports > Create Reports. For a description of how to create a report, see Create customized reports.

To complete pending events

1. Go to Manage > Billing and Distribution > Integration Events. The Integration Events page opens, with a table of all logged events. Events in pending status (yellow) include a Complete Event button.
2. Resolve the pending issue off-platform.
3. On the Integration Events page, under the event, click Complete Event. The Complete Event dialog opens.
4. Under Manually Resolve Event, select either Event Failed or Event Succeeded.
   If you select Event Failed, you must also select an error code from the Error Code drop-down list.
5. (Optional) Enter the account identifier. This is the same account (company) identifier that appears in the Identifiers column on the Integration Events list. You can change it if required.
6. (Optional) Enter the User Identifier. This is the same user identifier that appears in the Identifiers column on the Integration Events list. You can change it if required.
7. (Optional) To notify the customer that the event is complete, select Send an email notification to the customer about this event result.
8. Click Save.