zesty.io

Product

Use Cases

Integrations

Learn

Webhooks

A description on Zesty Webhooks and how to use them in production.

Open Perpetual Beta: Webhooks are available to all instances. We plan on expanding the payload of the webhook to include the data an meta data of affected resource.

Introduction

#

Webhooks allow for actions performed within the Zesty.io platform to trigger external actions via RESTful HTTP API calls. An example of such a use case would be to send out email or text message alerts to customers when a new blog article being published.

REST API Documentation and Examples

What Resources Listen for Webhooks

#

Instances API

  • Content Models
  • Content Model Items
  • Content Model Fields
  • Views
  • Stylesheets
  • Scripts
  • Redirects
  • Languages
  • Instance Setting

Accounts API

  • Role
  • Instance Roles
  • Instance Domains
  • Invites

Webhook for Publish Actions do not trigger for any publish event greater than 30 days out.

Create Webhook

Retrieve Webhook by ZUID

Retrieve Webhooks by Instance ZUID

Webhook Deletion

Webhook Conditions

#

Webhooks are executed by calling API endpoints. In order to create webhooks that will be triggered and executed by API calls, create webhooks with the following parameters. When an action occurs, such as content item creation, a search for the corresponding webhook will occur.

Example:

An item 7-ABCD-1234 corresponding to content model 6-ABCD-1234 has been updated in instance 8-ABCD-1234. Webhooks will be triggered based on the following action conditions.

  • Update on an item with ZUID 7-ABCD-1234 on an instance with ZUID 8-ABCD-1234
  • Update on any item belonging to content model 6-ABCD-1234 in instance 8-ABCD-1234
  • Update on any item in instance 8-ABCD-1234

Instances API Webhook

#

Create, Update, Delete and Publish Items

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new itemINSTANCE_ZUIDitemsCREATEPOST /content/model/MODEL_ZUID/items
Creating a new item for a given content modelINSTANCE_ZUIDMODEL_ZUIDitemsCREATEPOST /content/model/MODEL_ZUID/items
Updating a specific itemINSTANCE_ZUIDITEM_ZUIDUPDATEPUT /content/model/MODEL_ZUID/items/ITEM_ZUID
Updating any item for a given content modelINSTANCE_ZUIDMODEL_ZUIDitemsUPDATEPUT /content/model/MODEL_ZUID/items/ITEM_ZUID
Updating any itemINSTANCE_ZUIDitemsUPDATEPUT /content/model/MODEL_ZUID/items/ITEM_ZUID
Deleting a specific itemINSTANCE_ZUIDITEM_ZUIDDELETEDELETE /content/model/MODEL_ZUID/items/ITEM_ZUID
Deleting any item for a given content modelINSTANCE_ZUIDMODEL_ZUIDitemsDELETEDELETE /content/model/MODEL_ZUID/items/ITEM_ZUID
Deleting any itemINSTANCE_ZUIDitemsDELETEDELETE /content/model/MODEL_ZUID/items/ITEM_ZUID
Publishing any item for a given content modelINSTANCE_ZUIDMODEL_ZUIDitemsPUBLISHPOST /content/model/MODEL_ZUID/items/ITEM_ZUID/publishings
Publishing a specific itemINSTANCE_ZUIDITEM_ZUIDPUBLISHPOST /content/model/MODEL_ZUID/items/ITEM_ZUID/publishings
Publishing any itemINSTANCE_ZUIDitemsPUBLISHPOST /content/model/MODEL_ZUID/items/ITEM_ZUID/publishings

Creating, Updating and Deleting Content Models

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new content modelINSTANCE_ZUIDmodelsCREATEPOST /content/model
Update a specific content modelINSTANCE_ZUIDMODEL_ZUIDUPDATEPUT /content/model/MODEL_ZUID
Updating any content modelINSTANCE_ZUIDmodelsUPDATEPUT /content/model/MODEL_ZUID
Deleting a specific content modelINSTANCE_ZUIDMODEL_ZUIDDELETEDELETE /content/model/MODEL_ZUID
Deleting any content modelINSTANCE_ZUIDmodelsDELETEDELETE /content/model/MODEL_ZUID

Creating, Updating and Deleting Fields

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new fieldINSTANCE_ZUIDfieldsCREATEPOST /content/model/MODEL_ZUID/fields
Creating a new field for a given content modelINSTANCE_ZUIDMODEL_ZUIDfieldsCREATEPOST /content/model/MODEL_ZUID/fields
Updating a specific fieldINSTANCE_ZUIDFIELD_ZUIDUPDATEPUT /content/model/MODEL_ZUID/fields/FIELD_ZUID
Updating any field for a given content modelINSTANCE_ZUIDMODEL_ZUIDfieldsUPDATEPUT /content/model/MODEL_ZUID/fields/FIELD_ZUID
Updating any fieldINSTANCE_ZUIDfieldsUPDATEPUT /content/model/MODEL_ZUID/fields/FIELD_ZUID
Deleting a specific fieldINSTANCE_ZUIDFIELD_ZUIDDELETEDELETEDELETE /content/model/MODEL_ZUID/fields/FIELD_ZUID
Deleting any field for a given content modelINSTANCE_ZUIDMODEL_ZUIDfieldsDELETEDELETE /content/model/MODEL_ZUID/fields/FIELD_ZUID
Deleting any fieldINSTANCE_ZUIDfieldsDELETEDELETE /content/model/MODEL_ZUID/fields/FIELD_ZUID

Creating, Updating and Deleting Views

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new viewINSTANCE_ZUIDviewsCREATEPOST /web/views
Update a specific viewINSTANCE_ZUIDVIEW_ZUIDUPDATEPUT /web/views/VIEW_ZUID
Updating any viewINSTANCE_ZUIDviewsUPDATEPUT /web/views/VIEW_ZUID
Deleting a specific viewINSTANCE_ZUIDVIEW_ZUIDDELETEDELETE /web/views/VIEW_ZUID
Deleting any viewINSTANCE_ZUIDviewsDELETEDELETE /web/views/VIEW_ZUID

Creating, Updating and Deleting Stylesheets

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new stylesheetINSTANCE_ZUIDstylesheetsCREATEPOST /web/scripts
Update a specific stylesheetINSTANCE_ZUIDSTYLESHEET_ZUIDUPDATEPUT /web/scripts/SCRIPT_ZUID
Updating any stylesheetINSTANCE_ZUIDscriptsUPDATEPUT /web/scripts/SCRIPT_ZUID
Deleting a specific stylesheetINSTANCE_ZUIDSCRIPT_ZUIDDELETEDELETE /web/scripts/SCRIPT_ZUID
Deleting any stylesheetINSTANCE_ZUIDscriptsDELETEDELETE /web/scripts/SCRIPT_ZUID

Creating, Updating and Deleting Scripts

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new scriptINSTANCE_ZUIDscriptsCREATEPOST /web/scripts
Update a specific scriptINSTANCE_ZUIDSCRIPT_ZUIDUPDATEPUT /web/scripts/SCRIPT_ZUID
Updating any scriptINSTANCE_ZUIDscriptsUPDATEPUT /web/scripts/SCRIPT_ZUID
Deleting a specific scriptINSTANCE_ZUIDSCRIPT_ZUIDDELETEDELETE /web/scripts/SCRIPT_ZUID
Deleting any scriptINSTANCE_ZUIDscriptsDELETEDELETE /web/scripts/SCRIPT_ZUID

Creating, Updating and Deleting Redirects

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new redirectINSTANCE_ZUIDredirectsCREATEPOST /web/redirects
Update a specific redirectINSTANCE_ZUIDREDIRECT_ZUIDUPDATEPUT /web/redirects/REDIRECT_ZUID
Updating any redirectINSTANCE_ZUIDredirectsUPDATEPUT /web/redirects/REDIRECT_ZUID
Deleting a specific redirectINSTANCE_ZUIDREDIRECT_ZUIDDELETEDELETE /web/redirects/REDIRECT_ZUID
Deleting any redirectINSTANCE_ZUIDredirectsDELETEDELETE /web/redirects/REDIRECT_ZUID

Creating, Updating and Deleting Langs

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new languageINSTANCE_ZUIDlangsCREATEPOST /env/langs
Update a specific languageINSTANCE_ZUIDLANG_IDUPDATEPUT /env/langs/LANG_ID
Updating any languageINSTANCE_ZUIDlangsUPDATEPUT /env/langs/LANG_ID
Deleting a specific languageINSTANCE_ZUIDLANG_IDDELETEDELETE /env/langs/LANG_ID
Deleting any languageINSTANCE_ZUIDlangsDELETEDELETE /env/langs/LANG_ID

Creating, Updating and Deleting Settings

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new settingINSTANCE_ZUIDsettingsCREATEPOST /env/settings
Update a specific settingINSTANCE_ZUIDSETTINGS_ZUIDUPDATEPUT /env/settings/SETTINGS_ZUID
Updating any settingINSTANCE_ZUIDsettingsUPDATEPUT /env/settings/SETTINGS_ZUID
Deleting a specific settingINSTANCE_ZUIDSETTINGS_ZUIDDELETEDELETE /env/settings/SETTINGS_ZUID
Deleting any settingINSTANCE_ZUIDsettingsDELETEDELETE /env/settings/SETTINGS_ZUID

Creating, Updating and Deleting Leads

Accounts API Webhook

#

Roles

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Creating a new roleINSTANCE_ZUIDrolesCREATEPOST /roles

Instance Roles

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Generating a new Instance RoleINSTANCE_ZUIDINSTANCE_ZUIDrolesCREATEPOST /instances/INSTANCE_ZUID/roles

Instance Domains

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Create domain for a given instanceINSTANCE_ZUIDdomainsCREATEPOST /instances/INSTANCE_ZUID/domains
Update a specific domain for a given instanceINSTANCE_ZUIDDOMAIN_ZUIDUPDATEPUT /instances/INSTANCE_ZUID/domains/DOMAIN_ZUID
Update any domain for a given instanceINSTANCE_ZUIDdomainsUPDATEPUT /instances/INSTANCE_ZUID/domains/DOMAIN_ZUID
Delete a specific domain for a given instanceINSTANCE_ZUIDDOMAIN_ZUIDDELETEDELETE /instances/INSTANCE_ZUID/domains/DOMAIN_ZUID
Delete any domain for a given instanceINSTANCE_ZUIDdomainsDELETEDELETE /instances/INSTANCE_ZUID/domains/DOMAIN_ZUID

Invite

ConditionScoped ResourceParent ResourceResourceActionRequest URL
Create InviteINSTANCE_ZUIDinvitesCREATEPOST /invites
Respond to InviteINSTANCE_ZUIDINVITE_ZUIDUPDATEPUT /invites/INVITE_ZUID
Delete InviteINSTANCE_ZUIDINVITE_ZUIDDELETEDELETE /invites/INVITE_ZUID

Connect with Content Experts

Book a free 15-minute consultation with a content expert. Discuss your application, pain points and requirements. Understand how Zesty's lower total cost of ownership, features, functionality can elevate your business by creating extraordinary digital experiences.

Trusted By

zesty customer logo Sonyzesty customer logo Rocket Leaguezesty customer logo Singlifezesty customer logo Acornszesty customer logo Phoenix Sunszesty customer logo Wattpadzesty customer logo Corner Shopzesty customer logo Bjs

G2 MOMENTUM LEADER

zesty customer logo zesty customer logo zesty customer logo zesty customer logo

Enter your details to connect with a Content Expert

First Name

Last Name

Email

Phone (optional)

Company

Please tell us about your project (optional)