> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chargeapi.co/llms.txt
> Use this file to discover all available pages before exploring further.

# The Webhook Endpoint object

<div className="xl:hidden">
  <CodeGroup>
    ```json The Webhook Endpoint object theme={null}
    {
        "id": "wh_ciX3YSgbziEUrUrZ7eUwNnAJm89uT45f",
        "object": "webhook_endpoint",
        "api_version": "2026-03-01",
        "application": null,
        "created": "2026-04-01T00:25:13.233Z",
        "description": null,
        "enabled_events": ["report.succeeded", "reservation.confirmed"],
        "livemode": false,
        "metadata": {},
        "secret": "whsec_b5YszBNO5VEYUYlqK3fZ6IkhmgDQ4dLA",
        "status": "enabled",
        "url": "https://example.com/webhook/endpoint"
    }
    ```
  </CodeGroup>
</div>

<div className="hidden xl:block">
  <ResponseExample>
    ```json The Webhook Endpoint object theme={null}
    {
        "id": "wh_ciX3YSgbziEUrUrZ7eUwNnAJm89uT45f",
        "object": "webhook_endpoint",
        "api_version": "2026-03-01",
        "application": null,
        "created": "2026-04-01T00:25:13.233Z",
        "description": null,
        "enabled_events": ["report.succeeded", "reservation.confirmed"],
        "livemode": false,
        "metadata": {},
        "secret": "whsec_b5YszBNO5VEYUYlqK3fZ6IkhmgDQ4dLA",
        "status": "enabled",
        "url": "https://example.com/webhook/endpoint"
    }
    ```
  </ResponseExample>
</div>

This object represents a webhook endpoint in Charge. Use it to configure where Charge delivers signed event notifications and which event types a destination receives.

## Attributes

<ResponseField name="id" type="string">
  Unique identifier for the object.
</ResponseField>

<ResponseField name="enabled_events" type="array of string">
  Event types delivered to this endpoint.
</ResponseField>

<ResponseField name="status" type="string">
  Current status of the webhook endpoint.

  Available options: `enabled`, `disabled`
</ResponseField>

<ResponseField name="url" type="string">
  The URL that will receive the webhook POST requests.
</ResponseField>

## More attributes

<ResponseField name="object" type="string">
  String representing the object's type.
</ResponseField>

<ResponseField name="api_version" type="string | null">
  API version used for events delivered to this endpoint.
</ResponseField>

<ResponseField name="application" type="string | null">
  ID of the application associated with this webhook, if applicable.
</ResponseField>

<ResponseField name="created" type="string">
  Time at which the webhook endpoint was created. RFC 3339 UTC timestamp with millisecond precision, e.g. `2026-03-03T14:05:23.789Z`.
</ResponseField>

<ResponseField name="description" type="string | null">
  An optional description for the webhook endpoint.
</ResponseField>

<ResponseField name="livemode" type="boolean">
  Indicates whether this webhook endpoint is operating in live or test mode.
</ResponseField>

<ResponseField name="metadata" type="object">
  Set of key-value pairs that you can attach to an object.
</ResponseField>

<ResponseField name="secret" type="string">
  Secret used to sign webhook payloads sent to this endpoint.
</ResponseField>