PUT /api/v3/webhook/{webhookId}

Edits an existing webhook configuration

EditWebhookV3 Permissions: ApplicationSettings (Manage)
Use this endpoint to update a webhook’s URL, event subscriptions, or active status. Locked webhooks (system-managed) cannot be edited and will return an error. Requires ApplicationSettings Manage permission.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Path Parameters

Name Description Type Required
webhookId Unique numeric identifier of the webhook to edit integer (int32) Required

Request Body

WebhookEditRequest
Property Description Type
active The webhook activation status (true=Active, false=Inactive) Required boolean
mailingList List of email addresses. Each recipient in this list will receive an email when a webhook fails or gets disabled Required Cannot be Empty string[]
secret The encryption secret. Required string
url The URL to be invoked by the webhook Required string
webhookDescription The description for the webhook Required (defined) string
webhookEventTypeId The type of event that will trigger the webhook Required integer (int32)
webhookName The name of the webhook Required Must be between 0 and 64 characters string
Example Request Body application/json 
{  "active": false,  "mailingList": [
    "string"
  ],  "secret": "string",  "url": "string",  "webhookDescription": "string",  "webhookEventTypeId": 1,  "webhookName": "string"
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

WebhookResponse
Property Description Type
createdBy UserChild
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
createdDate The date and time the webhook was created string (date-time)
eventType WebhookEventTypeChild
WebhookEventTypeChild properties
Property Description Type
webhookEventTypeId The identifier for the webhook event type integer (int32)
webhookEventTypeName The name of the webhook event type string
locked Locked webhooks cannot be edited. Locked webhooks will also NOT be automatically disabled on 10 consecutive failures boolean
mailingList List of email addresses. Each recipient in this list will receive an email when a webhook fails or gets disabled string[]
secret The encryption secret string
successRate The percentage of success for the webhook number (double)
url The URL to be invoked by the webhook string
webhookDescription The description of the webhook string
webhookId The identifier of the webhook integer (int32)
webhookName The name of the webhook string
webhookStatus The activation status of the webhook string
Example Response application/json 
{  "createdBy": {    "fullName": "string",    "userCode": "string",    "userId": 1
  },  "createdDate": "2026-06-29",  "eventType": {    "webhookEventTypeId": 1,    "webhookEventTypeName": "string"
  },  "locked": false,  "mailingList": [
    "string"
  ],  "secret": "string",  "successRate": 1.0,  "url": "string",  "webhookDescription": "string",  "webhookId": 1,  "webhookName": "string",  "webhookStatus": "string"
}
400 Bad Request The request was malformed or contains invalid parameters. Check the request body and query parameters.
404 Not Found The requested resource was not found. Verify the ID or path is correct.