Site
A list of available Duda Webhook Events.
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. Event type: PUBLISH
{
"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"
}
| Name | Type | Description |
|---|---|---|
| data.republish | boolean | Boolean stating if this was a republish of an already published site |
| data.first_publish | boolean | Boolean stating if this was the first publish of a site |
| source.type | string | The location of the source for the publish event. Possible values are EDITOR or API |
| source.account_name | string | If a publish was triggered through the editor, then this contains the account who initiated the publish |
| resource_type | string | Always set to site for the publish event |
If a site is published after it was unpublished, then both
republishandfirst_publishare 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. Event type: UNPUBLISH
{
"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,
}
| Name | Type | Description |
|---|---|---|
| source.type | string | The location of the source for the unpublish event. Possible values are EDITOR or API |
| source.account_name | string | If 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. Event type: CONTACT_FORM_SENT_V2
{
"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",
"pageName": "Page Name"
},
"source": null,
"resource_data": {
"site_name": "974d714008f440529ea58094ccf9a97c"
},
"event_timestamp": 1569338502786,
"event_type": "CONTACT_FORM_SENT_V2"
}
| Name | Type | Description |
|---|---|---|
| utm_campaign | string | value of the utm_campaign query parameter when form was submitted |
| fieldsData | array | Array of all fields from the submitted form |
| recipients | array | Array of emails designated as recipient of form data |
| emailSubject | string | Subject set in form widget |
| emailSender | string | Sender set in form widget |
| pageName | string | Page name of page on which the form was placed |
| resource_data.site_name | string | Unique id of site on which the form was placed |
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. Event type: SITE_CREATED
{
"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"
}
| Name | Type | Description |
|---|---|---|
| source.type | string | The location of the source for the unpublish event. Possible values are EDITOR or API |
| source.account_name | string | This contains the account who initiated the site creation. |
| resource_type | Always 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. Event type: DOMAIN_UPDATED
{
"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"
}
| Name | Type | Description |
|---|---|---|
| data.domain | string | The current domain for the site. The value can be null |
| data.sub_domain | string | The current subdomain (default domain) for the site. |
| data.alternate_domains | array | List of optional alternate domains defined for this site |
| source.type | string | The location of the source for the publish event. Possible values are EDITOR or API |
| source.account_name | string | If a publish was triggered through the editor, then this contains the account who initiated the publish |
| resource_type | string | Always set to site for the domain update event |
Certificate Created
A notification is sent when the SSL certificate for a site is generated. The same created event will also fire when the status is updated to COMPLETE. Event type: CERTIFICATE_CREATED
Certificate Regeneration
A webhook event is not triggered when the certificate is generated. Duda will renew/regenerate a new certificate every 3 months, but no event will be triggered when this occurs.
{
"data": {
id: "12345abc",
domains: ["www.domain.com","domain.com"],
deployment_status: "DEPLOYED",
created: 1532467846492
},
"resource_data": {
"site_name": "8a8eda"
},
"event_type": "CERTIFICATE_CREATED",
"event_timestamp": 1683201225981
}
| Name | Type | Description |
|---|---|---|
| data.id | string | The id of the certificate generated. |
| data.domains | array | List of domains assigned to the generated certificate. This should include alternate domains and the www value, as well. |
| data.deployment_status | string | Status of the generated certificate. Can be: PENDING, DEPLOYED, or FAILED. |
Certificate Deleted
A notification is sent when the SSL certificate for a site is deleted. Event type: CERTIFICATE_DELETED
{
"data": {
id: "12345abc",
domains: ["www.domain.com","domain.com"],
created: 1532467846492,
},
"resource_data": {
"site_name": "8a8eda"
},
"event_type": "CERTIFICATE_DELETED",
"event_timestamp": 1683201225981
}
| Name | Type | Description |
|---|---|---|
| data.id | string | The id of the certificate deleted. |
| data.domains | array | List of domains associated with the deleted certificate. |
Site Plan Changed
A notification is sent when the plan ID of a site has been changed. Event type: SITE_PLAN_CHANGED
{
"data": {
"newPlanId":804,
"siteAlias":"2dbf8579",
"previousPlanId":802
},
"source": {
"type":"EDITOR",
"account_name":"[email protected]"
},
"resource_data": {
"site_name":"2dbf8579"
},
"event_timestamp":1686861354729,
"event_type":"SITE_PLAN_CHANGED"
}
| Name | Type | Description |
|---|---|---|
| data.newPlanId | int | The ID of the new Plan assigned to the site. |
| data.siteAlias | string | Duda's unique identifier for the Site. |
| data.previousPlanId | int | The ID of the plan the site was previously assigned to. |
| source.type | string | The location of the source for the plan changed event. Possible values are EDITOR or API |
| source.account_name | string | This contains the account who initiated the plan change. |
Backup Restored
A notification is sent when a backup is restored for a site. Event type: SITE_RESTORED
{
"data": 1686862504428,
"source": {
"type": "EDITOR",
"account_name": "[email protected]"
},
"resource_data": {
"site_name": "2dbf8579"
},
"event_timestamp": 1686862504455,
"event_type": "SITE_RESTORED"
}
| Name | Type | Description |
|---|---|---|
| data | timestamp | The date the back up was restored in Unix format |
| source.type | string | The location of the source for the backup restored event. Possible values are EDITOR or API |
| source.account_name | string | This contains the account who initiated the backup restore. |
Updated 3 months ago