Webhooks

Update a webhook

Changed on Oct 28, 2026

Updates an existing webhook for the authenticated customer. Its version does not change. sender_profile applies to a version 1 webhook and is_inheritable to a version 2 one; retry_count and timeout_seconds apply to version 1 only. A version 1 webhook's response returns its sender_profile selection as saved; a version 2 webhook's response leaves sender_profile out.

put/v3/webhooks/{id}

Request

Base URL
https://api.sent.dm
URL
https://api.sent.dm/v3/webhooks/{id}
Auth
- API key in header x-api-key
- or HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

display_namestring required

endpoint_urlstring

event_typesstring[]

event_filtersobject nullable

retry_countinteger

timeout_secondsinteger

is_inheritableboolean nullable

Makes this webhook inheritable by the organization's sender profiles (see create), or stops it being inheritable. Omit or pass null to keep it as it is. Only a version 2 webhook can be inheritable.

Example request

{
  "display_name": "Updated Order Notifications",
  "endpoint_url": "https://example.com/webhooks/orders-v2",
  "event_types": [
    "contact",
    "message",
    "templates"
  ],
  "event_filters": {
    "message": [
      "delivered",
      "failed"
    ]
  },
  "retry_count": 5,
  "timeout_seconds": 60
}

Response

Webhook updated successfully

successboolean

Indicates whether the request was successful

Changes

Oct 28, 202641acb2ceb84d Revision changes
- info
  added the new optional request property /
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
Oct 16, 20266c829543a93e Revision changes
- breaking
  added subschema #2: SentDmServicesEndpointsCustomerAPIv3WebhooksRequestsUpdateWebhookV3Request_Properties to the request body allOf list
- breaking
  added to the response property oneOf list for the response status
- breaking
  added to the response property oneOf list for the response status
- breaking
  added to the response property oneOf list for the response status
- breaking
  added to the response property oneOf list for the response status
- warning
  removed subschema #2: SentDmServicesEndpointsCustomerAPIv3RequestsWebhooksUpdateWebhookV3Request_Properties from the request body allOf list
- info
  the endpoint scheme security BearerAuth was added to the API
- info
  added to the response property allOf list for the response status
- info
  added to the response property allOf list for the response status
- info
  added to the response property allOf list for the response status
- info
  added to the response property allOf list for the response status
- info
  added to the response property allOf list for the response status
- info
  removed from the response property allOf list for the response status
- info
  removed from the response property allOf list for the response status
- info
  removed from the response property allOf list for the response status
- info
  removed from the response property allOf list for the response status
- info
  removed from the response property allOf list for the response status
- info
  removed from the response property oneOf list for the response status
- info
  removed from the response property oneOf list for the response status
- info
  removed from the response property oneOf list for the response status
- info
  removed from the response property oneOf list for the response status

Operation history