MailerUpdateWebhook

PUT mailer/webhook

Updates a webhook. Only the fields present in the request are changed, and the uuid never changes — the URL is already configured on the provider side.

Rotating secretKey takes effect immediately: events signed with the old secret start failing verification, so change it in the provider dashboard in the same maintenance window.

Access Control

Allowed role: admin, within the brand of the caller.

Request

RESTTCPSDK

PUT https://{broker_domain}/mailer/webhook

{
  "id": 2,
  "status": "DISABLED"
}

{
  "command": "MailerUpdateWebhook",
  "extID": "1",
  "data": {
    "id": 2,
    "status": "DISABLED"
  }
}

const res = await platform.MailerUpdateWebhook({
  id: 2,
  status: "DISABLED"
});

Request Data

Field	Type	Required	Description
id	int	Yes	Webhook id
name	string	No	Webhook name
description	string	No	Free-form note
profileId	int	No	Provider profile
status	enum	No	ENABLED or DISABLED
secretKey	string	No	New signing secret, 10..255 characters
secretKeyAutoGenerate	bool	No	Generate a new secret
events	array	No	Event names to accept

Response Data

{
  "id": 2,
  "profileId": 3,
  "uuid": "9f2a1c7d4b6e",
  "name": "Postmark events",
  "events": [],
  "status": "DISABLED",
  "path": "/mailer/handleWebhooks/9f2a1c7d4b6e",
  "updatedAt": "2026-08-24 14:48:02"
}

Errors

Code	Error	Description
400	VALIDATION_ERROR	Secret is shorter than 10 characters
400	PROVIDER_IS_DISABLED	The provider behind the target profile is disabled
404	NOT_FOUND	Webhook not found in the brand
404	PROFILE_NOT_FOUND	Target profile not found in the brand