# List integration events

Endpoint: GET /integrationEvents
Version: 1.0.457.36910
Security: OAuth2

## Query parameters:

  - `search` (string)
    Word or phrase to search for.

  - `searchOn` (array)
    Comma-delimited list of fields to search on.
    Enum: "ID", "EventType", "Name"

  - `sortBy` (array)
    Comma-delimited list of fields to sort by.
    Enum: "ID", "EventType", "Name", "!ID", "!EventType", "!Name"

  - `page` (integer)
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

  - `pageSize` (integer)
    Number of results to return per page.

  - `filters` (object)
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

## Response 200 fields (application/json):

  - `Items` (array)
    Example: [{"ElevatedRoles":["ApiClientAdmin"],"ID":"","ConfigData":{},"EventType":"OrderCheckout","CustomImplementationUrl":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":"","Name":"","HashKey":""}]

  - `Items.ElevatedRoles` (array)
    Enum: "ApiClientAdmin", "ApiClientReader", "AddressAdmin", "AddressReader", "AdminAddressAdmin", "AdminAddressReader", "AdminUserAdmin", "AdminUserGroupAdmin", "AdminUserGroupReader", "AdminUserReader", "ApprovalRuleAdmin", "ApprovalRuleReader", "BulkReader", "BundleAdmin", "BundleAssignmentAdmin", "BundleReader", "BuyerAdmin", "BuyerImpersonation", "BuyerReader", "BuyerUserAdmin", "BuyerUserReader", "CatalogAdmin", "CatalogReader", "CategoryAdmin", "CategoryReader", "CostCenterAdmin", "CostCenterReader", "CreditCardAdmin", "CreditCardReader", "EntitySyncConfigAdmin", "FullAccess", "IncrementorAdmin", "IncrementorReader", "LocaleReader", "LocaleAdmin", "MeAddressAdmin", "MeAdmin", "MeCreditCardAdmin", "MessageConfigAssignmentAdmin", "MeSubscriptionAdmin", "MeXpAdmin", "OrderAdmin", "OrderReader", "OverrideShipping", "OverrideTax", "OverrideUnitPrice", "PasswordReset", "PriceScheduleAdmin", "PriceScheduleReader", "ProductAdmin", "ProductAssignmentAdmin", "ProductCollectionReader", "ProductFacetAdmin", "ProductFacetReader", "ProductReader", "ProductSyncConfigAdmin", "PromotionAdmin", "PromotionReader", "SecurityProfileAdmin", "SecurityProfileReader", "SetSecurityProfile", "ShipmentAdmin", "ShipmentReader", "Shopper", "SpendingAccountAdmin", "SpendingAccountReader", "SubscriptionAdmin", "SubscriptionReader", "SupplierAddressAdmin", "SupplierAddressReader", "SupplierAdmin", "SupplierReader", "SupplierUserAdmin", "SupplierUserGroupAdmin", "SupplierUserGroupReader", "SupplierUserReader", "UnsubmittedOrderReader", "UserGroupAdmin", "UserGroupReader", "OpenIDConnectReader", "OpenIDConnectAdmin", "MessageSenderReader", "MessageSenderAdmin", "XpIndexAdmin", "WebhookReader", "WebhookAdmin", "IntegrationEventReader", "IntegrationEventAdmin", "TrackingEventReader", "TrackingEventAdmin", "DeliveryConfigAdmin", "OrderSyncConfigAdmin", "ErrorConfigAdmin"

  - `Items.ID` (string)

  - `Items.ConfigData` (object)
    Any additional data needed for your integration event should be included here.
    Example: {}

  - `Items.EventType` (string)
    Enum: "OrderCheckout", "OpenIDConnect", "OrderReturn", "AddToCart"

  - `Items.CustomImplementationUrl` (string)
    URL the integration event will POST data to, likely a route within your middleware.

  - `Items.CustomAuthHeaderName` (string)
    The header name that can be passed to your middleware.

  - `Items.CustomAuthHeaderValue` (string)
    The header value that can be passed to your middleware.

  - `Items.Name` (string)

  - `Items.HashKey` (string)
    Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.

  - `Meta` (object)

  - `Meta.Page` (integer)

  - `Meta.PageSize` (integer)

  - `Meta.TotalCount` (integer)

  - `Meta.TotalPages` (integer)

  - `Meta.ItemRange` (array)

  - `Meta.NextPageKey` (string)

## Response 4XX fields (application/json):

  - `StatusCode` (integer)
    Example: "404"

  - `ErrorCode` (string)
    Example: "NotFoundError"

  - `Message` (string)
    Example: "Object not found"

  - `Data` (object)
    Example: {"ObjectType":"","ObjectID":""}