Update a webhook

Updates an existing webhook for the authenticated customer.

PUT
/v3/webhooks/{id}

Path Parameters

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

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.

Match^[a-zA-Z0-9_-]+$
Lengthlength <= 255
x-profile-id?string

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.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://api.sent.dm/v3/webhooks/d4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8" \  -H "Idempotency-Key: req_abc123_retry1" \  -H "Content-Type: application/json" \  -d '{    "display_name": "Updated Order Notifications",    "endpoint_url": "https://example.com/webhooks/orders-v2",    "event_types": [      "messages",      "templates"    ],    "retry_count": 5,    "timeout_seconds": 60,    "sandbox": false  }'
{
  "success": true,
  "data": {
    "id": "d4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8",
    "display_name": "Updated Order Notifications",
    "endpoint_url": "https://example.com/webhooks/orders-v2",
    "signing_secret": null,
    "is_active": true,
    "event_types": [
      "messages",
      "templates"
    ],
    "retry_count": 5,
    "timeout_seconds": 60,
    "last_delivery_attempt_at": null,
    "last_successful_delivery_at": null,
    "consecutive_failures": 0,
    "created_at": "2026-01-15T10:30:00+00:00",
    "updated_at": "2026-02-05T16:45:00+00:00"
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.7459513+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_001",
    "message": "Endpoint URL must be a valid HTTP or HTTPS URL",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/VALIDATION_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.7459553+00:00",
    "version": "v3"
  }
}
Empty
Empty
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_008",
    "message": "Webhook not found",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/RESOURCE_008"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.745956+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "An unexpected error occurred while updating the webhook",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/INTERNAL_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.7459567+00:00",
    "version": "v3"
  }
}

Create a webhook POST

Creates a new webhook endpoint for the authenticated customer.

Delete a webhook DELETE

Deletes a webhook for the authenticated customer.