Get webhooks list

Retrieves a paginated list of webhooks for the authenticated customer.

GET
/v3/webhooks

Query Parameters

page*integer
Formatint32
page_size*integer
Formatint32
search?|
is_active?|

Header Parameters

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

Response Body

application/json

application/json

application/json

curl -X GET "https://api.sent.dm/v3/webhooks?page=1&page_size=20&is_active=true"
{
  "success": true,
  "data": {
    "webhooks": [
      {
        "id": "d4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8",
        "display_name": "Order Notifications",
        "endpoint_url": "https://example.com/webhooks/orders",
        "signing_secret": null,
        "is_active": true,
        "event_types": [
          "messages",
          "templates"
        ],
        "retry_count": 3,
        "timeout_seconds": 30,
        "last_delivery_attempt_at": null,
        "last_successful_delivery_at": null,
        "consecutive_failures": 0,
        "created_at": "2026-01-15T10:30:00+00:00",
        "updated_at": null
      }
    ],
    "pagination": {
      "page": 1,
      "page_size": 20,
      "total_count": 1,
      "total_pages": 1,
      "has_more": false,
      "cursors": null
    }
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.6788684+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_001",
    "message": "Page size must be between 1 and 100",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/VALIDATION_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.6788713+00:00",
    "version": "v3"
  }
}
Empty
Empty
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "An unexpected error occurred while retrieving webhooks",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/INTERNAL_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.6788718+00:00",
    "version": "v3"
  }
}