Skip to main content

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.

{
    "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"
}

{
    "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"
}
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

​
id
string
Unique identifier for the object.
​
enabled_events
array of string
Event types delivered to this endpoint.
​
status
string
Current status of the webhook endpoint.Available options: enabled, disabled
​
url
string
The URL that will receive the webhook POST requests.

​
More attributes

​
object
string
String representing the object’s type.
​
api_version
string | null
API version used for events delivered to this endpoint.
​
application
string | null
ID of the application associated with this webhook, if applicable.
​
created
string
Time at which the webhook endpoint was created. RFC 3339 UTC timestamp with millisecond precision, e.g. 2026-03-03T14:05:23.789Z.
​
description
string | null
An optional description for the webhook endpoint.
​
livemode
boolean
Indicates whether this webhook endpoint is operating in live or test mode.
​
metadata
object
Set of key-value pairs that you can attach to an object.
​
secret
string
Secret used to sign webhook payloads sent to this endpoint.