---
title: "Retrieve a webhook endpoint"
method: GET
path: "/webhookEndpoints/{id}"
tags: ["Webhook Endpoints"]
---

# Retrieve a webhook endpoint

`GET /webhookEndpoints/{id}`

Retrieves the webhook endpoint with the given ID.

## Path parameters

- `id` string, required

## Response `200`

Successfully retrieved the webhook endpoint.

- WebhookEndpoint
  - `id` string, required — Unique ID for the object.
  - `url` string — The URL of the webhook endpoint.
  - `enabledEvents` string[] — The list of events to enable for this endpoint.
  - `eventProperties` EventProperty[] — Optional configuration for event properties in webhook payloads. Specifies which properties should be included for specific event types. When `enabledEvents` contains `contact.attributes_changed`, this field is required and must contain at least one event property configuration for that event type.
    - `event` string, required — The event type for which properties are configured. This field accepts any valid event type that supports property configuration.
    - `properties` string[], required — A list of property names that should be included in the webhook payload for the specified event type. The available properties depend on the specific event type configured.
  - `description` string — An optional description of what the webhook is used for.
  - `status` 'active' | 'disabled' | 'pending' — Webhook endpoint status. - `active`: Indicates that the webhook endpoint is active, and will receive notifications of events monitored. - `disabled`: Indicates that the webhook endpoint is disabled, and will not receive notifications. - `pending`: Indicates that the webhook endpoint is pending, and will not receive notifications. If a webhook endpoint fails to receive notifications frequently, it changes to pending.
  - `secret` string — The endpoint's secret, used to generate webhook signatures.
  - `createTime` string, date-time — The time at which this object was created, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-06-01T12:00:00.000Z`.
  - `updateTime` string, date-time — The time at which this object was updated, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-06-01T12:00:00.000Z`.

## Other responses

- `404` — The requested resource does not exist.

---

[API](https://skmtc.dev/ycloud/apis/ycloud-api.md) · [All operations](https://skmtc.dev/ycloud/apis/ycloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ycloud/ycloud-api/revisions/4e13d3ca9df8/schema)