GuidesAPI ReferenceChangelogSupport Portal

Webhook Events Reference

A list of available Duda Webhook Events.

Suggest Edits

Site

All webhooks related to site events are listed below.

Publish

A notification is sent when a site is published. A publish can be triggered inside the Duda editor or via the publish API endpoint.

{
  "data": {
    "republish": false,
    "first_publish": true
  },
  "resource_data": {
    "site_name": "sw1d3f9f18eb4c82a472402505a731a1",
    "external_id": "my-external-id"
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
  },
  "event_type": "PUBLISH",
  "event_timestamp": 1532467846492,
  "resource_type": "site"
}
NameTypeDescription
data.republishbooleanBoolean stating if this was a republish of an already published site
data.first_publishbooleanBoolean stating if this was the first publish of a site
source.typestringThe location of the source for the publish event. Possible values are EDITOR or API
source.account_namestringIf a publish was triggered through the editor, then this contains the account who initiated the publish
resource_typestringAlways set to site for the publish event

📘

If a site is published after it was unpublished, then both republish and first_publish are false

Unpublish

A notification is sent when a site is unpublished. An unpubilsh can be triggered inside the Duda editor or via the unpublish API endpoint.

{
  "data": 1532482228987,
  "resource_data": {
    "site_name": "sw1d3f9f18eb4c82a472402505a731a1",
    "external_id": "my-external-id"
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
  },
  "event_type": "UNPUBLISH",
  "event_timestamp": 1532471227566,
}
NameTypeDescription
source.typestringThe location of the source for the unpublish event. Possible values are EDITOR or API
source.account_namestringIf an unpublish was triggered through the editor, then this contains the account who initiated the unpublish

Form Submission

A notification is sent when a new form submissions takes place on a site. 

{
 "data": {
   "utm_campaign": "MY_CAMPAIGN",  
   "fieldsData": [
     {
       "field_label": "Name",
       "field_value": "sdfsdf",
       "field_type": "text",
       "field_key": "",
       "field_id": "dmform-00"
     },
     {
       "field_label": "Message",
       "field_value": "sdfsdf",
       "field_type": "message",
       "field_key": "",
       "field_id": "dmform-01"
     },
     {
       "field_label": "Title",
       "field_value": "Contact Us",
       "field_type": "form_title",
       "field_key": "",
       "field_id": null
     }
   ],
   "recipients": [
      "[email protected]"
    ],
    "emailSubject": "Subject set in form widget",
    "emailSender": "Sender set in form widget"
 },
 "source": null,
 "resource_data": {
   "site_name": "974d714008f440529ea58094ccf9a97c"
 },
 "event_timestamp": 1569338502786,
 "event_type": "CONTACT_FORM_SENT_V2" 
}
NameTypeDescription
fieldsDataarrayArray of all fields from the submitted form
utm_campaignstringIf the user has a utm_campaign cookie in their session, then it will be added to the webhook

Site Creation

A notification is sent when a site is created. A site creation can be triggered inside the Duda editor or via the API

{
    "resource_data": {
       "site_name": "dfdd3f9f18eb4c82a472402505a731a1",
       "external_id": "my-external-id"
    },
    "source": {
       "type": "EDITOR",  
       "account_name": "[email protected]"
    },
       "event_type": "SITE_CREATED",
       "event_timestamp": 1532467846492,
       "resource_type": "site"
}
NameTypeDescription
source.typestringThe location of the source for the unpublish event. Possible values are EDITOR or API
source.account_namestringThis contains the account who initiated the site creation.
resource_typeAlways set to site for the site creation event

Domain Update

A notification is sent when the domain of a site is updated. A domain change can be triggered inside the Duda editor or via the update site API endpoint

{
  "data": {
    "domain": null,
    "sub_domain": "example-time.multiscreensite.com",
    "alternate_domains": []
  },
  "resource_data": {
    "site_name": "sw1d3f9f18eb4c82a472402505a731a1",
    "external_id": "my-external-id"
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
  },
  "event_type": "DOMAIN_UPDATED",
  "event_timestamp": 1532471131957,
  "resource_type": "site"
}
NameTypeDescription
data.domainstringThe current domain for the site. The value can be null
data.sub_domainstringThe current subdomain (default domain) for the site.
data.alternate_domainsarrayList of optional alternate domains defined for this site
source.typestringThe location of the source for the publish event. Possible values are EDITOR or API
source.account_namestringIf a publish was triggered through the editor, then this contains the account who initiated the publish
resource_typestringAlways set to site for the domain update event

Blog

All webhooks related to blog events are listed below.

Blog Post Publish

A notification is sent when a blog post is published. A publish can be triggered inside the Duda editor.

{
  "data": {
    "title": "The Art of Playing Baseball",
    "republish": true,
    "first_publish": false
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
   },
   "resource_data": {
    "site_name": "der45dtj3465tee"
   },
   "event_timestamp": 1567603977697,
   "event_type": "BLOG_POST_PUBLISH"
}
NameTypeDescription
data.titlestringThe title of the blog post
data.republishbooleanBoolean stating if this was a republish of an existing blog post
data.first_publishbooleanBoolean stating if this was the first publish of a blog post
source.typestringThe location of the source for the publish event. Possible values are EDITOR
source.account_namestringIf a publish was triggered through the editor, then this contains the account who initiated the publish

Site Comments

All webhooks related to site comments are listed below.

New Conversation

A notification is sent when a new conversation is created on a site. A publish can be triggered inside the Duda editor or via the publish API endpoint.

{
  "data": {
    "comment": {
      "text": "Please change this font to match our logo",
      "uuid": "5bfa1f6b-0426-4893-9f20-363efd20abb6"
    },
    "conversation_context": {
      "page_uuid": "88848a7e884147729b9f7b5c62c88377",
      "device": "DESKTOP",
      "conversation_number": 2
    },
    "conversation_uuid": "94320b30-96b1-40ad-a8f6-75eea204e255"
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
  },
  "resource_data": {
    "site_name": "8a8ed8f4d2a34032b5cdc10feb483527"
  },
  "event_timestamp": 1547849546045,
  "event_type": "NEW_CONVERSATION"
}
NameTypeDescription
data.comment.textstringThe text of the initial comment in the new conversation
data.comment.uuidstringUUID of the comment
data.conversation_context.page_uuidstringUUID of the page the comment was created on
data.conversation_context.devicestringThe device view in use when the comment was entered. Possible values are DESKTOP, TABLET, or MOBILE
data.conversation_context.conversation_numberintTracks the total number of conversations across a site. A conversation_number of 3 means this conversation is the 3rd conversation added to the site (regardless of page)
data.conversation_uuidstringUUID of the conversation
source.typestringThe location of the source for the event. Possible values are EDITOR or API
source.account_namestringAccount name of the user who authored the comment.

New Comment

A notification is sent when a new comment is added to an existing conversation.

{
  "data": {
    "comment": {
      "text": "Font family has been updated. Please confirm.",
      "uuid": "eafb2b72-2845-4d49-baf4-36f38ecc32a1"
    },
    "conversation_uuid": "0abab363-5b95-4f4e-a5d2-c7e39f993094"
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
  },
  "resource_data": {
    "site_name": "8a8b556ad2a34032b5cdc10feb483527"
  },
  "event_timestamp": 1547849618170,
  "event_type": "NEW_COMMENT"
}
NameTypeDescription
data.comment.textstringThe text of the new comment
data.comment.uuidstringUUID of the comment
data.conversaton_uuidstringUUID of the conversation
source.typestringThe location of the source of the event. Possible values are Editor or API
source.account_namestringThe account who authored the new comment

Conversation Update

A notification is sent when the status of a conversation has changed. A conversation can be resolved by a Team Member which will fire this webhook. Additionally a resolved conversation can be reopened which will fire a status of unresolved.

{
  "data": {
    "conversation_properties": {
      "status": "resolved",
      "deleted": false
    },
    "conversation_uuid": "e0fa2c71-c8a4-4cb7-b3f4-2040609a439b"
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
  },
  "resource_data": {
    "site_name": "8a8b556ad2a34032b5cdc10feb483527"
  },
  "event_timestamp": 1547849670851,
  "event_type": "CONVERSATION_UPDATED"
}
NameTypeDescription
data. conversation_properties.statusstringThe current status of the conversation. Possible values are "resolved, unresolved"
data. conversation_properties.deletedbooleanBoolean value depicting if conversation is deleted or not
data.conversation_uuidstringUUID of the conversation
source.typestringThe location of the source for the event. Possible values are EDITOR or API
source.account_namestringThe account who initiated the status change

Comment Edited

A notification is sent when a comment is edited. The webhook includes the complete comment object as shown below.

{
  "data": {
    "comment": {
      "text": "Please update with this image https://irp-cdn.multiscreensite.com/md/dmip/dms3rep/multi/woman-nature-smiling-green.jpg",
      "uuid": "abcbebdd-c430-444e-8ebb-ydaf78482bfc"
    },
    "conversation_uuid": "c4w79464-ed20-427e-9cb8-e1b89bab272b"
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
  },
  "resource_data": {
    "site_name": "je4ec1c6"
  },
  "event_timestamp": 1550081354524,
  "event_type": "COMMENT_EDITED"
}
NameTypeDescription
data.comment.textstringThe text of the comment
data.comment.uuidstringUUID of the comment
data.conversation_uuidstringUUID of the conversation
source.typestringThe location of the source for the event. Possible values are EDITOR or API
source.account_namestringThe account that initiated the edit

Comment Deleted

A notification is sent when a comment is deleted.

{
  "data": {
    "comment": {
      "uuid": "adcaddb0-8674-4f0f-be5e-c926d58e2053"
    },
    "conversation_uuid": "de6c0840-94d1-4e7c-a6ac-41360a42b98a"
  },
  "source": {
    "type": "EDITOR",
    "account_name": "[email protected]"
  },
  "resource_data": {
    "site_name": "je4ec1c6"
  },
  "event_timestamp": 1550081783440,
  "event_type": "COMMENT_DELETED"
}
NameTypeDescription
data.comment.uuidstringUUID of the comment
data.conversaton_uuidstringUUID of the conversation
source.typestringThe location of the source for the event. Possible values are EDITOR or API
source.account_namestringThe account that initiated the delete

Third Party Store

🚧

Documentation for the following webhooks is only applicable to the third party store.

Documentation for native store events will be coming soon. Contact your account manager if you are interested in utilizing native store data in your integration.

All webhooks related to store events are listed below.

Order Created

A notification is sent when a new order is created within the store.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "order.created",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": {
      "newPaymentStatus": "AWAITING_PAYMENT",
      "newFulfillmentStatus": "AWAITING_PROCESSING",
      "orderId": "1"
    }
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_ORDER_CREATED"
}
NameTypeDescription
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of order event
data.eventIdstringA unique identifier for the event
data.storeIdstringA unique identifier for the store on which the order originated
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the created entity. This field is deprecated and may be removed in the future. Migrate your applications to read the value from the data.data.orderId field. The orderId can be used when fetching order details via API.
data.data.newPaymentStatusstringPayment status for the order
data.data.newFulfillmentStatusstringFulfillment status for the order
data.data.orderIdstringA unique identifier for the order

Order Updated

A notification is sent when an order is updated within the editor UI. For instance, when changing the fulfillment status of an order.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "order.updated",
    "eventId": "49be7f69-05b0-4cd2-8e67-65af19811066",
    "storeId": 34313483,
    "eventCreated": 1597964890,
    "entityId": 1,
    "data": {
      "oldPaymentStatus": "AWAITING_PAYMENT",
      "newPaymentStatus": "PAID",
      "oldFulfillmentStatus": "AWAITING_PROCESSING",
      "newFulfillmentStatus": "DELIVERED",
      "orderId": "1"
    }
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964892412,
  "event_type": "STORE_ORDER_UPDATED"
}
NameTypeDescription
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of order event
data.eventIdstringA unique identifier for the event
data.storeIdstringA unique identifier for the store on which the order originated
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the updated entity. This field is deprecated and may be removed in the future. Migrate your applications to read the value from the data.data.orderId field. The orderId can be used when fetching order details via API.
data.data.newPaymentStatusstringThe updated payment status for the order
data.data.oldPaymentStatusstringThe previous payment status for the order
data.data.newFulfillmentStatusstringThe updated fulfillment status for the order
data.data.oldFulfillmentStatusstringThe previous fulfillment status for the order
data.data.orderIdstringA unique identifier for the order

Order Deleted

A notification is sent when an order is deleted.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "order.deleted",
    "eventId": "f821769b-8faa-4233-8e5c-a6426dcad42c",
    "storeId": 34313483,
    "eventCreated": 1597969480,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597969480789,
  "event_type": "STORE_ORDER_DELETED"
}
NameTypeDescription
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of order event
data.eventIdstringId of the deleted entity. This field is deprecated and may be removed in the future. Migrate your applications to read the value from the data.data.orderId field. The orderId can be used when fetching order details via API.
data.storeIdstringA unique identifier for the store on which the order originated
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the updated entity. (order notifications will always have a value equal to orderId)

Product Created

A notification is sent when a new product is created within the store.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "product.created",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_PRODUCT_CREATED"
}
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of product event
data.eventIdstringA unique identifier for the event
data.storeIdstringA unique identifier for the store on which the product was updated
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the updated product

Product Updated

A notification is sent when a product is updated.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "product.updated",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_PRODUCT_UPDATED"
}
NameTypeDescription
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of product event
data.eventIdstringA unique identifier for the event
data.storeIdstringA unique identifier for the store on which the product was updated
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the updated product

Product Deleted

A notification is sent when a product is deleted.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "product.deleted",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_PRODUCT_DELETED"
}
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of product event
data.eventIdstringA unique identifier for the event
data.storeIdstringA unique identifier for the store on which the product was deleted
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the deleted product

Category Created

A notification is sent when a product category is created.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "category.created",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_CATEGORY_CREATED"
}
NameTypeDescription
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of product event
data.eventIdstringA unique identifier for the event
data.storeIdstringA unique identifier for the store on which category was created
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the created category

Category Updated

A notification is sent when a product category is updated.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "category.updated",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_CATEGORY_UPDATED"
}
NameTypeDescription
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of product event
data.eventIdstringA unique identifier for the event
data.storeIdstringA unique identifier for the store on which category was updated
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the updated category

Category Deleted

A notification is sent when a category is deleted.

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "category.deleted",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_CATEGORY_DELETED"
}
NameTypeDescription
data.siteAliasstringA unique identifier of the site in which the storefront resides
data.eventTypestringType of product event
data.eventIdstringA unique identifier for the event
data.storeIdstringA unique identifier for the store on which the category was deleted
data.eventCreatedintA timestamp of when the event occurred
data.entityIdintId of the deleted category

Updated about 1 month ago