Topics
A list of all of the events that can be subscribed to using webhooks.
Users
user.created
{
"userId": "acc6938f-e91a-489d-b9cd-f3b6f819df6c",
"name": {
"forename": "Stokly",
"surname": "user"
},
"roleId": "5197ed75-d0d4-4545-a1bc-0cf63579a1aa"
} user.updated
{
"userId": "acc6938f-e91a-489d-b9cd-f3b6f819df6c",
"name": {
"forename": "Stokly",
"surname": "user"
},
"roleId": "5197ed75-d0d4-4545-a1bc-0cf63579a1aa"
} user.deleted
{
"userId": "acc6938f-e91a-489d-b9cd-f3b6f819df6c"
} Apps
app.installed
Triggered when a new app is added
{
"appId": "3e963fbf-786c-44d7-9c0a-e620a600039b",
"name": "Example App",
"type": "thirdparty",
"roleId": "00000000-0000-0000-0000-000000000003",
"permissions": [
"catalogue.items.read",
"catalogue.items.create"
]
}app.updated
Triggered when a new app is modified
{
"appId": "6ec666e2-3227-410f-bab8-2f90e465ad2d",
"name": "Example App",
"type": "secure",
"roleId": "acc6938f-e91a-489d-b9cd-f3b6f819df6c",
"permissions": [
"catalogue.items.read",
"catalogue.items.create"
]
}app.deleted
Triggered when a new app is removed
{
"appId": "6ec666e2-3227-410f-bab8-2f90e465ad2d",
}Suppliers
supplier.added
Triggered when a supplier is added
{
"supplierId": "a8a502f8-4882-49f6-938f-c6a8205c8e2d",
"name": "Example Supplier",
"type": 0,
"accountReference": "My Reference",
"currency": "GBP",
"minimumSpend": 500,
"address": {
"line1": "Example Supplier",
"line2": "Example Area",
"city": "Example Town",
"region": "West Exampleborough",
"country": "GB",
"postcode": "EX85PLE",
},
"contacts": [
{
"contactId": "9e6b0fe2-6f4e-4dd3-863a-533a841ff3ae",
"fullname": {
"forename": "Example",
"surname": "Person",
},
"phone": "1242588977",
"email": "[email protected]"
}
]
}supplier.updated
Triggered when a supplier is modified
{
"supplierId": "a8a502f8-4882-49f6-938f-c6a8205c8e2d",
"name": "Example Supplier",
"type": 0,
"accountReference": "My Reference",
"currency": "GBP",
"minimumSpend": 500,
"address": {
"line1": "Example Supplier",
"line2": "Example Area",
"city": "Example Town",
"region": "West Exampleborough",
"country": "GB",
"postcode": "EX85PLE",
},
"contacts": [
{
"contactId": "9e6b0fe2-6f4e-4dd3-863a-533a841ff3ae",
"fullname": {
"forename": "Example",
"surname": "Person",
},
"phone": "1242588977",
"email": "[email protected]"
}
]
}supplier.deleted
Triggered when a supplier is removed
{
"supplierId": "a8a502f8-4882-49f6-938f-c6a8205c8e2d",
}Manufacturers
Locations
Item Attributes
Item Types
Items
item.created
Triggered when an item is added
{
"itemId": "6e134343-4e44-4215-9d0b-adda2e40d51d",
"name": "Example Item",
"sku": "example-001",
"typeId": "8130cfb5-51ad-4811-81f0-0f522aaf7d56",
"acquisition": 0,
"tags": [
"heavy"
],
"salePrice": 25.99,
"inventoryUnit": "single"
}item.updated
Triggered when an item is modified
{
"itemId": "6e134343-4e44-4215-9d0b-adda2e40d51d",
"name": "Example Item",
"sku": "example-001",
"typeId": "8130cfb5-51ad-4811-81f0-0f522aaf7d56",
"acquisition": 0,
"tags": [
"heavy"
],
"salePrice": 25.99,
"inventoryUnit": "single"
}item.deleted
Triggered when an item is removed
{
"itemId": "6e134343-4e44-4215-9d0b-adda2e40d51d"
}Channels
Shipping Providers
Packaging
Purchase Orders
Goods Receipts
Stock Transfers
Stock Adjustments
Stock Takes
Manufacturing Runs
Sale Orders
Customers
Goods Out Notes
Picks
Returns
Credit Notes
Variances
Updated 4 months ago
Did this page help you?