Get a webhook

Retrieves a single webhook by ID for the authenticated customer.

GET
/v3/webhooks/{id}

Path Parameters

id*string
Formatuuid

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

application/json

curl -X GET "https://api.sent.dm/v3/webhooks/d4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8"
{
  "success": true,
  "data": {
    "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": "2026-01-20T14:15:00+00:00"
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.6680696+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_001",
    "message": "Invalid webhook ID format.",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/VALIDATION_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.6680731+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.6680738+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "An unexpected error occurred while retrieving the webhook",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/INTERNAL_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:49.6680744+00:00",
    "version": "v3"
  }
}