Create or update an integration event.
PUT
/integrationEvents/{integrationEventID}
200Description
If an object with the same ID already exists, it will be overwritten.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessIntegrationEventAdmin
Parameters
| Name | Type | Description | Possible Values | |
|---|---|---|---|---|
| integrationEventID | Required | string | ID of the integration event. | --- |
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ElevatedRoles | array | --- | --- | --- | ||
| ID | string | --- | 100 characters | --- | ||
| ConfigData | object | --- | --- | --- | ||
| EventType | string | --- | --- | OrderCheckout, OpenIDConnect, OrderReturn, AddToCart | ||
| CustomImplementationUrl | Required | string | --- | --- | --- | |
| Name | Required | string | --- | --- | --- | |
| HashKey | Required | string | --- | 50 characters | --- | |
Response Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ElevatedRoles | array | --- | --- | --- | ||
| ID | string | --- | 100 characters | --- | ||
| ConfigData | object | --- | --- | --- | ||
| EventType | string | --- | --- | OrderCheckout, OpenIDConnect, OrderReturn, AddToCart | ||
| CustomImplementationUrl | string | --- | --- | --- | ||
| Name | string | --- | --- | --- | ||
| HashKey | string | --- | 50 characters | --- | ||
Create or update an integration event.
PUT
/integrationEvents/{integrationEventID}
200Description
If an object with the same ID already exists, it will be overwritten.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessIntegrationEventAdmin
Parameters
| Name | Type | Description | Possible Values | |
|---|---|---|---|---|
| integrationEventID | Required | string | ID of the integration event. | --- |
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ElevatedRoles | array | --- | --- | --- | ||
| ID | string | --- | 100 characters | --- | ||
| ConfigData | object | --- | --- | --- | ||
| EventType | string | --- | --- | OrderCheckout, OpenIDConnect, OrderReturn, AddToCart | ||
| CustomImplementationUrl | Required | string | --- | --- | --- | |
| Name | Required | string | --- | --- | --- | |
| HashKey | Required | string | --- | 50 characters | --- | |
Response Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ElevatedRoles | array | --- | --- | --- | ||
| ID | string | --- | 100 characters | --- | ||
| ConfigData | object | --- | --- | --- | ||
| EventType | string | --- | --- | OrderCheckout, OpenIDConnect, OrderReturn, AddToCart | ||
| CustomImplementationUrl | string | --- | --- | --- | ||
| Name | string | --- | --- | --- | ||
| HashKey | string | --- | 50 characters | --- | ||