All Events

form_submission

Details about a form submission

Required Scope | forms:read

Properties

FieldTypeDescription
namestringThe name of the form
siteIdstringThe id of the site that the form was submitted from
dataobjectThe data submitted in the form (key-value pairs for each field)
submittedAtstringThe timestamp the form was submitted
formIdstringThe id of the form submission

Example Payload

1{
2 "triggerType": "form_submission",
3 "payload": {
4 "name": "Sample Form",
5 "siteId": "62749158efef318abc8d5a0f",
6 "data": {
7 "name": "Some One",
8 "email": "some.one@home.com"
9 },
10 "submittedAt": "2022-09-14T12:35:16.117Z",
11 "formId": "6321ca84df3949bfc6752327"
12 }
13}

site_publish

Details about a site publish event

Required Scope | sites:read

Properties

FieldTypeDescription
siteIdstringThe identifier for the site that was published
publishedOnstringThe timestamp of the publish event (ISO8601 string)
domains[string]The domains that the site was published to
publishedByobjectThe name of the user who published the site

Example Payload

1{
2 "triggerType": "site_publish",
3 "payload": {
4 "siteId": "62749158efef318abc8d5a0f",
5 "publishedOn": "2023-07-31T12:34:56.789Z",
6 "domains": [
7 "my-website.webflow.io"
8 ],
9 "publishedBy": {
10 "displayName": "Some One"
11 }
12 }
13}

page_created

Details about a new page event

Required Scope | pages:read

Properties

FieldTypeDescription
siteIdstringID of the Site that the page is on
pageIdstringID of the new page
pageTitlestringTitle of the page
createdOnstringTimestamp of when the page was created, as an ISO8601 string

Example

1{
2 "triggerType": "page_created",
3 "payload": {
4 "siteId": "63499e4e6e9ed55a17e42b68",
5 "pageId": "641371d477a18c936fe237cd",
6 "pageTitle": "This is a New Page",
7 "createdOn": "2023-03-16T19:45:24.311Z"
8 }
9}

page_metadata_updated

Metadata of page is updated and published.

Required Scope | pages:read

Properties

FieldTypeDescription
siteIdstringID of the Site that the page is on
pageIdstringID of the new page
pageTitlestringTitle of the page
lastUpdatedstringTimestamp of when the page was updated as an ISO8601 string

Example

1{
2 "triggerType": "page_metadata_updated",
3 "payload": {
4 "siteId": "63499e4e6e9ed55a17e42b68",
5 "pageId": "641371d477a18c936fe237cd",
6 "pageTitle": "Home",
7 "lastUpdated": "2023-03-16T19:48:48.499Z"
8 }
9}

page_deleted

The information about a deleted page

Required Scope | pages:read

Properties

FieldTypeDescription
siteIdstringID of the Site that the page is on
pageId stringID of the new page
pageTitle stringTitle of the page
deletedOn stringTimestamp of when the page was deleted as an ISO8601 string

Example

1{
2 "triggerType": "page_deleted",
3 "payload": {
4 "siteId": "63499e4e6e9ed55a17e42b68",
5 "pageId": "63499e4e6e9ed5abbfe42b69",
6 "pageTitle": "Old Home",
7 "deletedOn": "2023-03-16T19:51:33.068Z"
8 }
9}

ecomm_new_order

The information about the new order

Required Scope | ecommerce:read

Properties

FieldTypeDescription
orderIdstringThe order id. Will usually be 6 hex characters, but can also be 9 hex characters if the site has a very large number of orders. Randomly assigned.
statusstringOne of pending, unfulfilled, fulfilled, disputed, dispute-lost, or refunded
commentstringA comment string for this order editable by API user (not used by Webflow).
orderCommentstringA comment that the customer left when making their order
acceptedOnstringThe ISO8601 timestamp that an order was placed.
disputedOnstringIf an order was disputed by the customer, then this key will be set with the ISO8601 timestamp that Stripe notifies Webflow. Null if not disputed.
disputeUpdatedOnstringIf an order was disputed by the customer, then this key will be set with the ISO8601 timestamp of the last time that we got an update. Null if not disputed.
disputeLastStatusstringIf an order was disputed by the customer, then this key will be set with the dispute’s status.
fulfilledOnstringIf an order was marked as ‘fulfilled’, then this is the ISO8601 timestamp when that happened.
refundedOnstringIf an order was refunded, this is the ISO8601 of when that happened.
customerPaidOrderAmountAn instance of the OrderAmount object.
netAmountOrderAmountAn instance of the OrderAmount object.
requiresShippingbooleanA boolean indicating whether the order contains one or more purchased items that require shipping.
shippingProviderstringA string editable by the API user to note the shipping provider used (not used by Webflow).
shippingTrackingstringA string editable by the API user to note the shipping tracking number for the order (not used by Webflow).
customerInfoOrderCustomerInfoAn instance of the OrderCustomerInfo object.
allAddresses[OrderAddress]All addresses provided by the customer during the ordering flow.
shippingAddressOrderAddressAn instance of the OrderAddress object.
billingAddressOrderAddressAn instance of the OrderAddress object.
purchasedItems[OrderPurchasedItem]An array of all things that the customer purchased.
stripeDetailsStripeDetailsAn instance of the StripeDetails object.
stripeCardStripeCardAn instance of the StripeCard object.
totalsOrderTotalsAn instance of the OrderTotals object.
customData[object]An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value.
downloadFiles[OrderDownloadedFile]An array of downloadable file objects.

Example Payload

1{
2 "triggerType": "ecomm_new_order",
3 "payload": {
4 "orderId": "dfa-3f1",
5 "status": "unfulfilled",
6 "comment": "",
7 "orderComment": "",
8 "acceptedOn": "2018-12-03T22:06:15.761Z",
9 "disputedOn": null,
10 "disputeUpdatedOn": null,
11 "disputeLastStatus": null,
12 "fulfilledOn": null,
13 "refundedOn": null,
14 "customerPaid": {
15 "unit": "USD",
16 "value": 6099,
17 "string": "$60.99"
18 },
19 "netAmount": {
20 "unit": "USD",
21 "value": 5892,
22 "string": "$58.92"
23 },
24 "requiresShipping": true,
25 "shippingProvider": null,
26 "shippingTracking": null,
27 "customerInfo": {
28 "fullName": "Customerio Namen",
29 "email": "renning+customer@webflow.com"
30 },
31 "allAddresses": [
32 {
33 "type": "billing",
34 "addressee": "Customerio Namen",
35 "line1": "123 Example Rd",
36 "line2": "",
37 "city": "Examplesville",
38 "state": "CA",
39 "country": "US",
40 "postalCode": "90012"
41 },
42 {
43 "type": "shipping",
44 "addressee": "Customerio Namen",
45 "line1": "123 Example Rd",
46 "line2": "",
47 "city": "Examplesville",
48 "state": "CA",
49 "country": "US",
50 "postalCode": "90012"
51 }
52 ],
53 "shippingAddress": {
54 "type": "shipping",
55 "addressee": "Customerio Namen",
56 "line1": "123 Example Rd",
57 "line2": "",
58 "city": "Examplesville",
59 "state": "CA",
60 "country": "US",
61 "postalCode": "90012"
62 },
63 "billingAddress": {
64 "type": "billing",
65 "addressee": "Customerio Namen",
66 "line1": "123 Example Rd",
67 "line2": "",
68 "city": "Examplesville",
69 "state": "CA",
70 "country": "US",
71 "postalCode": "90012"
72 },
73 "purchasedItems": [
74 {
75 "count": 1,
76 "rowTotal": {
77 "unit": "USD",
78 "value": 5500,
79 "string": "$55.00"
80 },
81 "productId": "5eb9fd05caef491eb9757183",
82 "productName": "White Cup",
83 "productSlug": "white-cup",
84 "variantId": "5eb9fcace279761d8199790c",
85 "variantName": "white-cup_default_sku",
86 "variantSlug": "white-cup-default-sku",
87 "variantImage": {
88 "fileId": "5bfedb42bab0ad90fa7dad2e",
89 "url": "https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png"
90 },
91 "variantPrice": {
92 "unit": "USD",
93 "value": 5500,
94 "string": "$55.00"
95 },
96 "height": 7,
97 "length": 2,
98 "weight": 5,
99 "width": 4
100 }
101 ],
102 "purchasedItemsCount": 1,
103 "stripeDetails": {
104 "refundReason": null,
105 "refundId": null,
106 "disputeId": null,
107 "chargeId": "ch_1DdPYQKMjGA7k9mI2AKiBY6u",
108 "customerId": "cus_E5ajeiWNHEtcAW"
109 },
110 "stripeCard": {
111 "last4": "4242",
112 "brand": "Visa",
113 "ownerName": "Customerio Namen",
114 "expires": {
115 "year": 2023,
116 "month": 12
117 }
118 },
119 "totals": {
120 "subtotal": {
121 "unit": "USD",
122 "value": 5500,
123 "string": "$55.00"
124 },
125 "extras": [
126 {
127 "type": "tax",
128 "name": "State Taxes",
129 "description": "CA Taxes (6.25%)",
130 "price": {
131 "unit": "USD",
132 "value": 344,
133 "string": "$3.44"
134 }
135 },
136 {
137 "type": "tax",
138 "name": "County Taxes",
139 "description": "LOS ANGELES Taxes (1.00%)",
140 "price": {
141 "unit": "USD",
142 "value": 55,
143 "string": "$0.55"
144 }
145 },
146 {
147 "type": "tax",
148 "name": "Special District Taxes",
149 "description": "Special District Taxes (2.25%)",
150 "price": {
151 "unit": "USD",
152 "value": 124,
153 "string": "$1.24"
154 }
155 },
156 {
157 "type": "shipping",
158 "name": "Flat Rate",
159 "description": "",
160 "price": {
161 "unit": "USD",
162 "value": 599,
163 "string": "$5.99"
164 }
165 },
166 {
167 "type": "discount",
168 "name": "Discount (SAVE5)",
169 "description": "",
170 "price": {
171 "unit": "USD",
172 "value": -500,
173 "string": "-$ 5.00 USD"
174 }
175 }
176 ],
177 "total": {
178 "unit": "USD",
179 "value": 6122,
180 "string": "$61.22"
181 }
182 },
183 "customData": [
184 {
185 "textInput": "(415) 123-4567",
186 "name": "Telephone"
187 },
188 {
189 "textArea": "Happy birthday Mom!",
190 "name": "Gift note"
191 },
192 {
193 "checkbox": true,
194 "name": "Send as gift"
195 }
196 ],
197 "downloadFiles": [
198 {
199 "id": "5e9a5eba75e0ac242e1b6f64",
200 "name": "The modern web design process - Webflow Ebook.pdf",
201 "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa"
202 },
203 {
204 "id": "5e9a5eba75e0ac242e1b6f63",
205 "name": "The freelance web designers guide - Webflow Ebook.pdf",
206 "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5dd44c493543b37d5449b3cd;5e9a5eba75e0ac242e1b6f63:ka2nehxy:6af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079"
207 }
208 ]
209 }
210}

ecomm_order_changed

The information about the order that changed

Required Scope | ecommerce:read

Properties

FieldTypeDescription
orderIdstringThe order id. Will usually be 6 hex characters, but can also be 9 hex characters if the site has a very large number of orders. Randomly assigned.
statusstringOne of pending, unfulfilled, fulfilled, disputed, dispute-lost, or refunded
commentstringA comment string for this order editable by API user (not used by Webflow).
orderCommentstringA comment that the customer left when making their order
acceptedOnstringThe ISO8601 timestamp that an order was placed.
disputedOnstringIf an order was disputed by the customer, then this key will be set with the ISO8601 timestamp that Stripe notifies Webflow. Null if not disputed.
disputeUpdatedOnstringIf an order was disputed by the customer, then this key will be set with the ISO8601 timestamp of the last time that we got an update. Null if not disputed.
disputeLastStatusstringIf an order was disputed by the customer, then this key will be set with the dispute’s status.
fulfilledOnstringIf an order was marked as ‘fulfilled’, then this is the ISO8601 timestamp when that happened.
refundedOnstringIf an order was refunded, this is the ISO8601 of when that happened.
customerPaidOrderAmountAn instance of the OrderAmount object.
netAmountOrderAmountAn instance of the OrderAmount object.
requiresShippingbooleanA boolean indicating whether the order contains one or more purchased items that require shipping.
shippingProviderstringA string editable by the API user to note the shipping provider used (not used by Webflow).
shippingTrackingstringA string editable by the API user to note the shipping tracking number for the order (not used by Webflow).
customerInfoOrderCustomerInfoAn instance of the OrderCustomerInfo object.
allAddresses[OrderAddress]All addresses provided by the customer during the ordering flow.
shippingAddressOrderAddressAn instance of the OrderAddress object.
billingAddressOrderAddressAn instance of the OrderAddress object.
purchasedItems[OrderPurchasedItem]An array of all things that the customer purchased.
stripeDetailsStripeDetailsAn instance of the StripeDetails object.
stripeCardStripeCardAn instance of the StripeCard object.
totalsOrderTotalsAn instance of the OrderTotals object.
customData[object]An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value.
downloadFiles[OrderDownloadedFile]An array of downloadable file objects.

Example Payload

1{
2 "triggerType": "ecomm_order_changed",
3 "payload": {
4 "orderId": "dfa-3f1",
5 "status": "unfulfilled",
6 "comment": "",
7 "orderComment": "",
8 "acceptedOn": "2018-12-03T22:06:15.761Z",
9 "disputedOn": null,
10 "disputeUpdatedOn": null,
11 "disputeLastStatus": null,
12 "fulfilledOn": null,
13 "refundedOn": null,
14 "customerPaid": {
15 "unit": "USD",
16 "value": 6099,
17 "string": "$60.99"
18 },
19 "netAmount": {
20 "unit": "USD",
21 "value": 5892,
22 "string": "$58.92"
23 },
24 "requiresShipping": true,
25 "shippingProvider": null,
26 "shippingTracking": null,
27 "customerInfo": {
28 "fullName": "Customerio Namen",
29 "email": "renning+customer@webflow.com"
30 },
31 "allAddresses": [
32 {
33 "type": "billing",
34 "addressee": "Customerio Namen",
35 "line1": "123 Example Rd",
36 "line2": "",
37 "city": "Examplesville",
38 "state": "CA",
39 "country": "US",
40 "postalCode": "90012"
41 },
42 {
43 "type": "shipping",
44 "addressee": "Customerio Namen",
45 "line1": "123 Example Rd",
46 "line2": "",
47 "city": "Examplesville",
48 "state": "CA",
49 "country": "US",
50 "postalCode": "90012"
51 }
52 ],
53 "shippingAddress": {
54 "type": "shipping",
55 "addressee": "Customerio Namen",
56 "line1": "123 Example Rd",
57 "line2": "",
58 "city": "Examplesville",
59 "state": "CA",
60 "country": "US",
61 "postalCode": "90012"
62 },
63 "billingAddress": {
64 "type": "billing",
65 "addressee": "Customerio Namen",
66 "line1": "123 Example Rd",
67 "line2": "",
68 "city": "Examplesville",
69 "state": "CA",
70 "country": "US",
71 "postalCode": "90012"
72 },
73 "purchasedItems": [
74 {
75 "count": 1,
76 "rowTotal": {
77 "unit": "USD",
78 "value": 5500,
79 "string": "$55.00"
80 },
81 "productId": "5eb9fd05caef491eb9757183",
82 "productName": "White Cup",
83 "productSlug": "white-cup",
84 "variantId": "5eb9fcace279761d8199790c",
85 "variantName": "white-cup_default_sku",
86 "variantSlug": "white-cup-default-sku",
87 "variantImage": {
88 "fileId": "5bfedb42bab0ad90fa7dad2e",
89 "url": "https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png"
90 },
91 "variantPrice": {
92 "unit": "USD",
93 "value": 5500,
94 "string": "$55.00"
95 },
96 "height": 7,
97 "length": 2,
98 "weight": 5,
99 "width": 4
100 }
101 ],
102 "purchasedItemsCount": 1,
103 "stripeDetails": {
104 "refundReason": null,
105 "refundId": null,
106 "disputeId": null,
107 "chargeId": "ch_1DdPYQKMjGA7k9mI2AKiBY6u",
108 "customerId": "cus_E5ajeiWNHEtcAW"
109 },
110 "stripeCard": {
111 "last4": "4242",
112 "brand": "Visa",
113 "ownerName": "Customerio Namen",
114 "expires": {
115 "year": 2023,
116 "month": 12
117 }
118 },
119 "totals": {
120 "subtotal": {
121 "unit": "USD",
122 "value": 5500,
123 "string": "$55.00"
124 },
125 "extras": [
126 {
127 "type": "tax",
128 "name": "State Taxes",
129 "description": "CA Taxes (6.25%)",
130 "price": {
131 "unit": "USD",
132 "value": 344,
133 "string": "$3.44"
134 }
135 },
136 {
137 "type": "tax",
138 "name": "County Taxes",
139 "description": "LOS ANGELES Taxes (1.00%)",
140 "price": {
141 "unit": "USD",
142 "value": 55,
143 "string": "$0.55"
144 }
145 },
146 {
147 "type": "tax",
148 "name": "Special District Taxes",
149 "description": "Special District Taxes (2.25%)",
150 "price": {
151 "unit": "USD",
152 "value": 124,
153 "string": "$1.24"
154 }
155 },
156 {
157 "type": "shipping",
158 "name": "Flat Rate",
159 "description": "",
160 "price": {
161 "unit": "USD",
162 "value": 599,
163 "string": "$5.99"
164 }
165 },
166 {
167 "type": "discount",
168 "name": "Discount (SAVE5)",
169 "description": "",
170 "price": {
171 "unit": "USD",
172 "value": -500,
173 "string": "-$ 5.00 USD"
174 }
175 }
176 ],
177 "total": {
178 "unit": "USD",
179 "value": 6122,
180 "string": "$61.22"
181 }
182 },
183 "customData": [
184 {
185 "textInput": "(415) 123-4567",
186 "name": "Telephone"
187 },
188 {
189 "textArea": "Happy birthday Mom!",
190 "name": "Gift note"
191 },
192 {
193 "checkbox": true,
194 "name": "Send as gift"
195 }
196 ],
197 "downloadFiles": [
198 {
199 "id": "5e9a5eba75e0ac242e1b6f64",
200 "name": "The modern web design process - Webflow Ebook.pdf",
201 "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa"
202 },
203 {
204 "id": "5e9a5eba75e0ac242e1b6f63",
205 "name": "The freelance web designers guide - Webflow Ebook.pdf",
206 "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5dd44c493543b37d5449b3cd;5e9a5eba75e0ac242e1b6f63:ka2nehxy:6af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079"
207 }
208 ]
209 }
210}

ecomm_inventory_changed

The information about the inventory item that changed

Required Scope | ecommerce:read

Properties

FieldTypeDescription
idstringUnique identifier for a SKU item
quantitynumberTotal quantity of items remaining in inventory (if finite)
inventoryTypestringString enum of infinite or finite

Example Payload

1{
2 "triggerType": "ecomm_inventory_changedr",
3 "payload": {
4 "id": "5bfedb42bab0ad90fa7dad39",
5 "quantity": 83,
6 "inventoryType": "finite"
7 }
8}

user_account_added

The information about the user account that was added

Required Scope | users:read

Properties

FieldTypeDescription
id stringUnique identifier for the User
isEmailVerifiedbooleanIndicates whether the user has verified their email address
lastUpdated stringThe timestamp the user was updated
createdOn stringThe timestamp the user was created
statusstringThe status of the user

Example Payload

1{
2 "triggerType": "user_account_added",
3 "payload": {
4 "id": "6287ec36a841b25637c663df",
5 "isEmailVerified": true,
6 "lastUpdated": "2022-05-20T13:46:12.093Z",
7 "createdOn": "2022-05-20T13:46:12.093Z",
8 "status": "verified",
9 "accessGroups": [
10 {
11 "slug": "webflowers",
12 "type": "admin"
13 }
14 ],
15 "data": {
16 "accept-privacy": false,
17 "accept-communications": false,
18 "email": "Some.One@home.com",
19 "name": "Some One"
20 }
21 }
22}

user_account_updated

The information about the user account that was updated

Required Scope | users:read

Properties

FieldTypeDescription
id stringUnique identifier for the User
isEmailVerifiedbooleanIndicates whether the user has verified their email address
lastUpdated stringThe timestamp the user was updated
createdOn stringThe timestamp the user was created
statusstringThe status of the user
accessGroupsarrayA list of access groups the user belongs to

Example Payload

1{
2 "triggerType": "user_account_updated",
3 "payload": {
4 "id": "6287ec36a841b25637c663df",
5 "isEmailVerified": true,
6 "lastUpdated": "2022-05-20T13:46:12.093Z",
7 "createdOn": "2022-05-20T13:46:12.093Z",
8 "status": "verified",
9 "accessGroups": [
10 {
11 "slug": "webflowers",
12 "type": "admin"
13 }
14 ],
15 "data": {
16 "accept-privacy": false,
17 "accept-communications": false,
18 "email": "Some.One@home.com",
19 "name": "Some One"
20 }
21 }
22}

user_account_deleted

The information about the user account that was deleted

Required Scope | users:read

Properties

FieldTypeDescription
id stringUnique identifier for the User
isEmailVerifiedbooleanIndicates whether the user has verified their email address
lastUpdated stringThe timestamp the user was updated
createdOn stringThe timestamp the user was created
statusstringThe status of the user
accessGroupsarrayA list of access groups the user belongs to

Example Payload

1{
2 "triggerType": "user_account_deleted",
3 "payload": {
4 "id": "6287ec36a841b25637c663df",
5 "isEmailVerified": true,
6 "lastUpdated": "2022-05-20T13:46:12.093Z",
7 "createdOn": "2022-05-20T13:46:12.093Z",
8 "status": "verified",
9 "accessGroups": [
10 {
11 "slug": "webflowers",
12 "type": "admin"
13 }
14 ],
15 "data": {
16 "accept-privacy": false,
17 "accept-communications": false,
18 "email": "Some.One@home.com",
19 "name": "Some One"
20 }
21 }
22}

collection_item_created

The information about the collection item that was created

Required Scope | cms:read

Properties

FieldTypeDescription
id stringUnique identifier for the Item
siteIdstringUnique identifier for the Site where the Collection lives
workspaceIdstringUnique identifier for the Workspace where the Site lives
collectionIdstringUnique identifier for the Collection
lastPublishedstringDate and time of when the item was last published, will be null if the item has never been published.
lastUpdatedstringDate and time of when the item was last updated
createdOnstringDate and time of when the item was created
isArchived booleanBoolean determining if the Item is set to archived
isDraft booleanBoolean determining if the Item is set to draft

Example Payload

1{
2 "triggerType": "collection_item_created",
3 "payload": {
4 "id": "582b900cba19143b2bb8a759",
5 "siteId": "1111111",
6 "workspaceId": "1111111",
7 "collectionId": "1111111",
8 "lastPublished": null,
9 "lastUpdated": "2023-03-27T22:26:40.926Z",
10 "createdOn": "2023-03-27T22:26:40.926Z",
11 "archived": false,
12 "draft": true,
13 // depends on the field schema
14 "fieldData": {
15 "name": "hello world",
16 "slug": "hello-world",
17 "favoriteColor": "#ff00ff"
18 }
19 }
20}

collection_item_changed

The information about the collection item that was changed

Required Scope | cms:read

Properties

FieldTypeDescription
id stringUnique identifier for the Item
siteIdstringUnique identifier for the Site where the Collection lives
workspaceIdstringUnique identifier for the Workspace where the Site lives
collectionIdstringUnique identifier for the Collection
lastPublishedstringDate and time of when the item was last published, will be null if the item has never been published.
lastUpdatedstringDate and time of when the item was last updated
createdOnstringDate and time of when the item was created
isArchived booleanBoolean determining if the Item is set to archived
isDraft booleanBoolean determining if the Item is set to draft
fieldDataobjectObject containing the item details structured within the Collection’s schema.

Example Payload

1{
2 "triggerType": "collection_item_changed",
3 "payload": {
4 "id": "582b900cba19143b2bb8a759",
5 "siteId": "1111111",
6 "workspaceId": "1111111",
7 "collectionId": "1111111",
8 "lastPublished": null,
9 "lastUpdated": "2023-03-27T22:26:40.926Z",
10 "createdOn": "2023-03-27T22:26:40.926Z",
11 "archived": false,
12 "draft": true,
13 "fieldData": {
14 "name": "hello world",
15 "slug": "hello-world",
16 "favoriteColor": "#ff00ff"
17 }
18 }
19}

collection_item_deleted

The results from deleting the collection item

Required Scope | cms:read

Properties

FieldTypeDescription
idstringThe unique identifier of the collection item that was deleted
siteId stringThe unique identifier of the Site the Collection belongs to
workspaceIdstringThe unique identifier of the Workspace the related Site belongs to
collectionIdstringThe unique identifier of the Collection the deleted item belongs to

Example Payload

1{
2 "triggerType": "collection_item_deleted",
3 "payload": {
4 "id": "647f35d49f499fe22e6dc173",
5 "siteId": "63692ab61fb28552c22ba8e3",
6 "workspaceId": "63499d0dd2f3b4e46108efa3",
7 "collectionId": "63692ab61fb285e2ff2ba8f3"
8 }
9}

collection_item_unpublished

The results from unpublishing the collection item

Required Scope | cms:read

Properties

FieldTypeDescription
idstringThe unique identifier of the collection item that was deleted
siteId stringThe unique identifier of the Site the Collection belongs to
workspaceIdstringThe unique identifier of the Workspace the related Site belongs to

Example Payload

1{
2 "triggerType": "collection_item_unpublished",
3 "payload": {
4 "id": "647f35d49f499fe22e6dc173",
5 "siteId": "63692ab61fb28552c22ba8e3",
6 "workspaceId": "63499d0dd2f3b4e46108efa3",
7 "collectionId": "63692ab61fb285e2ff2ba8f3"
8 }
9}