POST /v1/events/custom
Custom Events
Servers
- https://api.attentivemobile.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
externalEventId |
String | No | |
properties |
Object | No | |
properties.orderStatusURL |
String | No | |
properties.shippingFee[] |
Array | No | |
properties.shippingFee[].value |
Number | No | |
properties.shippingFee[].currency |
String | No | |
properties.shippingQty |
Number | No | |
properties.orderId |
String | No | |
properties.shipment |
Object | No | |
properties.shipment.carrier |
String | No | |
properties.shipment.trackingNumber |
String | No | |
properties.delivered |
Boolean | No | |
properties.deliveryDate |
String | No | |
user |
Object | No | |
user.email |
String | No | |
user.phone |
String | No | |
user.externalIdentifiers |
Object | No | |
user.externalIdentifiers.clientUserId |
String | No | |
user.externalIdentifiers.customIdentifiers[] |
Array | No | |
user.externalIdentifiers.customIdentifiers[].name |
String | No | |
user.externalIdentifiers.customIdentifiers[].value |
String | No | |
occurredAt |
String | No | |
type |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.