GET /v1/webhooks/{id} — retrieve a webhook configuration

The Get Webhook endpoint returns the complete configuration for a single registered webhook. Use it to inspect a webhook’s subscribed event types, current status, and cumulative delivery statistics. This endpoint requires the webhooks:read permission.

Request

GET https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/webhooks/{id}

Headers

string

required

Bearer token using your API key. Format: Bearer cs_live_your_key

Path parameters

string

required

The unique identifier of the webhook to retrieve (e.g., wh_01hx4kz9mntd8vr2bpqe5ycf3a).

Response

200 — success

string

Unique identifier for the webhook endpoint.

string

The destination HTTPS URL where events are delivered.

array[string]

List of event types this webhook is subscribed to.

string

Current status of the webhook. One of ACTIVE, DISABLED, or DELETED.

string

Optional human-readable description provided at registration.

integer

Unix timestamp (seconds) when the webhook was registered.

integer

Unix timestamp (seconds) of the most recent delivery attempt. null if no deliveries have occurred.

integer

Total number of successful event deliveries to this endpoint.

integer

Total number of failed delivery attempts to this endpoint.

401 — unauthorized

Returned when your API key is missing, invalid, or lacks the webhooks:read permission.

404 — not found

Returned when no webhook with the given id exists under your merchant account.

Example

curl https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/webhooks/wh_01hx4kz9mntd8vr2bpqe5ycf3a \
  -H "Authorization: Bearer cs_live_your_key"

Sample response

{
  "webhookId": "wh_01hx4kz9mntd8vr2bpqe5ycf3a",
  "url": "https://yourapp.com/webhooks/charitystack",
  "events": [
    "donation.created",
    "subscription.created",
    "subscription.cancelled"
  ],
  "status": "ACTIVE",
  "description": "Production webhook for donation notifications",
  "createdAt": 1714003200,
  "lastDeliveryAt": 1714089600,
  "successCount": 142,
  "failureCount": 3
}

Organization

Payments

Subscriptions

Contacts

Forms

Prefilled-Checkout Links

Webhooks

Analytics

GET /v1/webhooks/{id} — retrieve a webhook configuration

Request

Headers

Path parameters

Response

200 — success

401 — unauthorized

404 — not found

Example

​Request

​Headers

​Path parameters

​Response

​200 — success

​401 — unauthorized

​404 — not found

​Example

Request

Headers

Path parameters

Response

200 — success

401 — unauthorized

404 — not found

Example