Get a webhook endpoint
The webhook_endpoints.get operation: GET /api/v1/webhook_endpoints/{id} in the REST API and the webhook_endpoints_get tool in the MCP server.
GET
/api/v1/webhook_endpoints/{id}Returns one webhook endpoint of the brand in the request's mode: its URL, event types, whether it is enabled (and why not), and since when its deliveries have been failing. Never its signing secret.
At a glance
- REST:
GET /api/v1/webhook_endpoints/{id} - MCP tool:
webhook_endpoints_get - Operation ID:
webhook_endpoints.get - Scope: Brand
- Permission:
webhooks:read - Risk tier:
read - Dry run: Not supported
- Idempotency: Not needed (read only)
- Modes: Test and live
- Authentication: API key with the
webhooks:readscope - Since: M4
Request
Path parameters
| Field | Type | Description |
|---|---|---|
id | we_… ID |
Query parameters
This operation takes no query parameters.
Response
200 OK with a JSON object:
| Field | Type | Description |
|---|---|---|
id | we_… ID | |
object | "webhook_endpoint" | |
brandId | brd_… ID | |
livemode | boolean | |
url | string | |
description | string or null | |
events | array of string | |
enabled | boolean | |
disabledReason | one of manual, failing or null | |
disabledAt | date-time or null | |
failingSince | date-time or null | |
secretRotatedAt | date-time or null | |
previousSecretExpiresAt | date-time or null | |
metadata | object | |
createdAt | date-time | |
updatedAt | date-time |
Examples
An endpoint
HTTP
GET /api/v1/webhook_endpoints/we_01m4tx5nj8emwbyf7y9vcf47z0
Authorization: Bearer or_test_…
Response (200):
JSON
{
"id": "we_01m4tx5nj8emwbyf7y9vcf47z0",
"object": "webhook_endpoint",
"brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
"livemode": false,
"url": "https://example.com/webhooks/ownrecord",
"description": "Order fulfilment",
"events": ["customer.created", "checkout.session.completed"],
"enabled": true,
"disabledReason": null,
"disabledAt": null,
"failingSince": null,
"secretRotatedAt": null,
"previousSecretExpiresAt": null,
"metadata": {},
"createdAt": "2026-10-13T12:00:00.000Z",
"updatedAt": "2026-10-13T12:00:00.000Z"
}
Errors
| Code | HTTP status | When | What to do |
|---|---|---|---|
resource_not_found | 404 | No endpoint with this ID is visible to the request. | Check the ID and that your credentials are scoped to the right organization, entity, brand and mode. |
permission_denied | 403 | You can't see this brand's webhooks. | Ask an organization owner or admin for a role or scope that allows this action. |
It can also return these common errors: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, scope_required, dry_run_not_supported, rate_limited, internal_error.