--- updatedAt: 2026-06-25T14:00:51.000Z agentTools: projectIndex: https://marketing.developer.dotdigital.com/llms.txt --- # Update webhook configuration Updates an individual webhook configuration. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Webhook API", "description": "Provides methods for creating, retrieving, updating, and deleting webhook\nconfigurations. Also exposes endpoints to list all available webhook event\ntypes and their associated payload templates, enabling callers to set up\nevent-driven integrations.", "version": "1.0.1" }, "servers": [ { "url": "https://{region}-api.dotdigital.com", "variables": { "region": { "description": "The Dotdigital region id your account belongs to", "enum": [ "r1", "r2", "r3" ], "default": "r1" } } } ], "security": [ { "basicAuth": [] } ], "paths": { "/cpaas/webhooks/{webhookId}": { "put": { "tags": [ "Webhooks API" ], "summary": "Update webhook configuration", "description": "Updates an individual webhook configuration.", "parameters": [ { "name": "webhookId", "in": "path", "description": "The webhook id", "required": true, "schema": { "type": "string" } }, { "name": "if-match", "in": "header", "description": "An optional ETag for optimistic concurrency control", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Detail of the webhook configuration to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfigurationCreateUpdate" } } }, "required": true }, "responses": { "200": { "description": "The updated webhook configuration", "headers": { "ETag": { "description": "A unique value representing the version of the webhook configuration, optionally used for optimistic concurrency control on PUT and DELETE", "schema": { "type": "string" } }, "Last-Modified": { "description": "The date the webhook configuration was last updated in ISO 8601 format", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfiguration" } } } }, "404": { "description": "The webhook configuration was not found", "content": {} } }, "x-codegen-request-body-name": "webhookData" } } }, "components": { "schemas": { "EventFilters": { "type": "object", "properties": { "name": { "type": "string", "description": "name of filter", "example": "channel" }, "value": { "type": "string", "description": "value to watch", "example": "sms" } } }, "WebhookEvents": { "type": "object", "properties": { "type": { "type": "string", "description": "type of event", "example": "message.delivered" }, "filters": { "type": "array", "description": "Array of used filters", "items": { "$ref": "#/components/schemas/EventFilters" } } }, "example": [ { "type": "message.sent", "filters": [] }, { "type": "message.delivered", "filters": [] }, { "type": "message.expired", "filters": [] }, { "type": "message.failed", "filters": [] }, { "type": "message.inbound", "filters": [] }, { "type": "message.read", "filters": [] } ] }, "WebhookConfigurationCreateUpdate": { "required": [ "name", "url" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the webhook configuration", "example": "crm_system" }, "url": { "type": "string", "description": "The target url of the webhook", "example": "https://mycrm.example.com/webhooksReceive" }, "secret": { "type": "string", "description": "The secret used to create HMAC secure hash", "example": "f946b0e7-5fe9-4f57-9d8f-62b3ac0b4a13" }, "subscriptions": { "type": "array", "description": "Events for webhook", "items": { "$ref": "#/components/schemas/WebhookEvents" } }, "batch": { "type": "boolean", "description": "Whether to use event batching, or send single events", "example": true }, "maxBatchSize": { "maximum": 500, "minimum": 1, "type": "number", "description": "Maximum number of events to batch before it is sent", "example": 100 }, "batchTimeout": { "maximum": 60, "minimum": 1, "type": "number", "description": "Maximum duration in seconds to wait before a batch is sent", "example": 60 } } }, "WebhookConfiguration": { "allOf": [ { "type": "object", "properties": { "id": { "pattern": "^([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|[a-f0-9]{32}$", "type": "string", "description": "The Api Space's unique identifier" }, "_createdOn": { "type": "string", "description": "The date (in UTC, ISO 8601 format) that the webhook was created", "format": "date-time", "readOnly": true }, "_createdBy": { "type": "string", "description": "The identity that created the webhook" }, "_updatedOn": { "type": "string", "description": "The date (in UTC, ISO 8601 format) that the webhook was last updated", "format": "date-time", "readOnly": true }, "_updatedBy": { "type": "string", "description": "The identity that created the webhook", "readOnly": true } } }, { "$ref": "#/components/schemas/WebhookConfigurationCreateUpdate" } ] } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "x-readme.samples-languages": [ "curl", "csharp", "java", "javascript", "node", "python", "php", "ruby" ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true } } ``` # Sibling pages * [Get webhooks](https://marketing.developer.dotdigital.com/reference/get_cpaas-webhooks.md) * [Create webhook](https://marketing.developer.dotdigital.com/reference/post_cpaas-webhooks.md) * [Retrieves available webhook events](https://marketing.developer.dotdigital.com/reference/get_cpaas-webhooks-availableevents.md) * [Get event templates](https://marketing.developer.dotdigital.com/reference/get_cpaas-webhooks-availabletemplates.md) * [Retrieves webhook configuration](https://marketing.developer.dotdigital.com/reference/get_cpaas-webhooks-webhookid.md) * [Deletes webhook](https://marketing.developer.dotdigital.com/reference/delete_cpaas-webhooks-webhookid.md)